You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2017/10/25 14:37:15 UTC
[isis] 01/08: ISIS-1742: removes support for exploration prefix for
actions
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-1632-meta-annotations
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 575a3135a6143584e488400dade52b64aa1ce8d2
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Oct 17 18:37:16 2017 +0100
ISIS-1742: removes support for exploration prefix for actions
---
.../isis/applib/annotation/NatureOfService.java | 13 +--
.../MethodPrefixBasedFacetFactoryAbstract.java | 1 -
.../ActionNamedExplorationFacetFactory.java | 121 ---------------------
.../interaction/ActionNamedFacetFactory.java | 73 +++++++++++++
.../actions/ActionMethodsFacetFactoryTest.java | 6 +-
todo-deprecation-list.txt | 32 +++---
6 files changed, 94 insertions(+), 152 deletions(-)
diff --git a/core/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java b/core/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
index 0502d80..e64fb4f 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
@@ -30,20 +30,15 @@ public enum NatureOfService {
VIEW,
/**
* The service's actions appear on menus but do not contribute.
- *
- * <p>
- * Equivalent to annotating all actions with (the now deprecated) {@link org.apache.isis.applib.annotation.NotContributed} annotation.
- * </p>
*/
VIEW_MENU_ONLY,
/**
* The service's actions can be contributed to domain objects as actions, properties or collections but do not
* appear on menus.
*
- * <p>
- * Equivalent to annotating all actions with (the now deprecated) {@link org.apache.isis.applib.annotation.NotInServiceMenu} annotation.
- * </p>
+ * @deprecated - use mixins instead
*/
+ @Deprecated
VIEW_CONTRIBUTIONS_ONLY,
/**
* The services actions should only be visible in the REST API exposed by the Restful Objects viewer.
@@ -51,10 +46,6 @@ public enum NatureOfService {
VIEW_REST_ONLY,
/**
* The service's actions do not appear on menus and are not contributed.
- *
- * <p>
- * Equivalent to annotating all actions with both (the now deprecated) {@link org.apache.isis.applib.annotation.NotInServiceMenu} and {@link org.apache.isis.applib.annotation.NotContributed} annotations).
- * </p>
*/
DOMAIN;
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/MethodPrefixBasedFacetFactoryAbstract.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/MethodPrefixBasedFacetFactoryAbstract.java
index 67a20a9..e246268 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/MethodPrefixBasedFacetFactoryAbstract.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/MethodPrefixBasedFacetFactoryAbstract.java
@@ -44,7 +44,6 @@ public abstract class MethodPrefixBasedFacetFactoryAbstract
private final List<String> prefixes;
- protected static final Object[] NO_PARAMETERS = new Object[0];
protected static final Class<?>[] NO_PARAMETERS_TYPES = new Class<?>[0];
private final OrphanValidation orphanValidation;
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/actions/interaction/ActionNamedExplorationFacetFactory.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/actions/interaction/ActionNamedExplorationFacetFactory.java
deleted file mode 100644
index b14ceee..0000000
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/actions/interaction/ActionNamedExplorationFacetFactory.java
+++ /dev/null
@@ -1,121 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-package org.apache.isis.core.metamodel.facets.actions.interaction;
-
-import java.lang.reflect.Method;
-
-import org.apache.isis.core.commons.config.IsisConfiguration;
-import org.apache.isis.core.commons.lang.StringExtensions;
-import org.apache.isis.core.metamodel.facetapi.Facet;
-import org.apache.isis.core.metamodel.facetapi.FacetHolder;
-import org.apache.isis.core.metamodel.facetapi.FacetUtil;
-import org.apache.isis.core.metamodel.facetapi.FeatureType;
-import org.apache.isis.core.metamodel.facetapi.MetaModelValidatorRefiner;
-import org.apache.isis.core.metamodel.facets.MethodPrefixBasedFacetFactoryAbstract;
-import org.apache.isis.core.metamodel.facets.actions.prototype.PrototypeFacet;
-import org.apache.isis.core.metamodel.facets.all.named.NamedFacet;
-import org.apache.isis.core.metamodel.facets.all.named.NamedFacetInferred;
-import org.apache.isis.core.metamodel.services.ServicesInjector;
-import org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorComposite;
-import org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorForDeprecatedMethodPrefix;
-
-/**
- * Sets up {@link org.apache.isis.core.metamodel.facets.actions.action.invocation.ActionDomainEventFacet} and also an {@link org.apache.isis.core.metamodel.facets.actions.action.invocation.ActionInvocationFacet}, along with a number of supporting
- * facets that are based on the action's name.
- *
- * <p>
- * The supporting methods are: {@link PrototypeFacet}. In addition a {@link NamedFacet} is inferred from the
- * name (taking into account the above well-known prefixes).
- *
- * @deprecated
- */
-@Deprecated
-public class ActionNamedExplorationFacetFactory extends MethodPrefixBasedFacetFactoryAbstract implements MetaModelValidatorRefiner {
-
- private static final String EXPLORATION_PREFIX = "Exploration";
-
- private final MetaModelValidatorForDeprecatedMethodPrefix explorationValidator = new MetaModelValidatorForDeprecatedMethodPrefix(EXPLORATION_PREFIX);
-
- private static final String[] PREFIXES = { EXPLORATION_PREFIX };
-
- public ActionNamedExplorationFacetFactory() {
- super(FeatureType.ACTIONS_ONLY, OrphanValidation.VALIDATE, PREFIXES);
- }
-
- // ///////////////////////////////////////////////////////
- // Actions
- // ///////////////////////////////////////////////////////
-
- @Override
- public void process(final ProcessMethodContext processMethodContext) {
-
- // DebugFacet, ExplorationFacet
- attachExplorationFacetIfActionMethodNamePrefixed(processMethodContext);
-
- // inferred name
- // (must be called after the attachinvocationFacet methods)
- attachNamedFacetInferredFromMethodName(processMethodContext);
- }
-
-
- private void attachExplorationFacetIfActionMethodNamePrefixed(final ProcessMethodContext processMethodContext) {
-
- final Method actionMethod = processMethodContext.getMethod();
- final String capitalizedName = StringExtensions.asCapitalizedName(actionMethod.getName());
- if (!capitalizedName.startsWith(EXPLORATION_PREFIX)) {
- return;
- }
- final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
- final Facet facet = new PrototypeFacetViaExplorationPrefixNamingConvention(facetedMethod, getDeploymentCategory());
- FacetUtil.addFacet(explorationValidator.flagIfPresent(facet, processMethodContext));
- }
-
- /**
- * Must be called after added the debug, exploration etc facets.
- */
- private void attachNamedFacetInferredFromMethodName(final ProcessMethodContext processMethodContext) {
-
- final Method method = processMethodContext.getMethod();
- final String capitalizedName = StringExtensions.asCapitalizedName(method.getName());
-
- // this is nasty...
- String name = capitalizedName;
- name = StringExtensions.removePrefix(name, EXPLORATION_PREFIX);
- name = StringExtensions.asNaturalName2(name);
-
- final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
- FacetUtil.addFacet(new NamedFacetInferred(name, facetedMethod));
- }
-
-
- @Override
- public void refineMetaModelValidator(final MetaModelValidatorComposite metaModelValidator, final IsisConfiguration configuration) {
- metaModelValidator.add(explorationValidator);
- }
-
- @Override
- public void setServicesInjector(final ServicesInjector servicesInjector) {
- super.setServicesInjector(servicesInjector);
- IsisConfiguration configuration = servicesInjector.getConfigurationServiceInternal();
- explorationValidator.setConfiguration(configuration);
- }
-
-
-}
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/actions/interaction/ActionNamedFacetFactory.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/actions/interaction/ActionNamedFacetFactory.java
new file mode 100644
index 0000000..4f991e2
--- /dev/null
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/actions/interaction/ActionNamedFacetFactory.java
@@ -0,0 +1,73 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.isis.core.metamodel.facets.actions.interaction;
+
+import java.lang.reflect.Method;
+
+import org.apache.isis.core.commons.lang.StringExtensions;
+import org.apache.isis.core.metamodel.facetapi.FacetHolder;
+import org.apache.isis.core.metamodel.facetapi.FacetUtil;
+import org.apache.isis.core.metamodel.facetapi.FeatureType;
+import org.apache.isis.core.metamodel.facets.MethodPrefixBasedFacetFactoryAbstract;
+import org.apache.isis.core.metamodel.facets.all.named.NamedFacet;
+import org.apache.isis.core.metamodel.facets.all.named.NamedFacetInferred;
+
+/**
+ * Sets up {@link org.apache.isis.core.metamodel.facets.actions.action.invocation.ActionDomainEventFacet} and also an {@link org.apache.isis.core.metamodel.facets.actions.action.invocation.ActionInvocationFacet}, along with a number of supporting facets that are based on the action's name.
+ *
+ * <p>
+ * In addition a {@link NamedFacet} is inferred from the name.
+ *
+ * @deprecated
+ */
+@Deprecated
+public class ActionNamedFacetFactory extends MethodPrefixBasedFacetFactoryAbstract {
+
+ public ActionNamedFacetFactory() {
+ super(FeatureType.ACTIONS_ONLY, OrphanValidation.VALIDATE);
+ }
+
+ // ///////////////////////////////////////////////////////
+ // Actions
+ // ///////////////////////////////////////////////////////
+
+ @Override
+ public void process(final ProcessMethodContext processMethodContext) {
+
+ attachNamedFacetInferredFromMethodName(processMethodContext);
+ }
+
+
+
+ /**
+ * Must be called after added the debug, exploration etc facets.
+ */
+ private void attachNamedFacetInferredFromMethodName(final ProcessMethodContext processMethodContext) {
+
+ final Method method = processMethodContext.getMethod();
+
+ String name = StringExtensions.asCapitalizedName(method.getName());
+ name = StringExtensions.asNaturalName2(name);
+
+ final FacetHolder facetedMethod = processMethodContext.getFacetHolder();
+ FacetUtil.addFacet(new NamedFacetInferred(name, facetedMethod));
+ }
+
+}
diff --git a/core/metamodel/src/test/java/org/apache/isis/core/metamodel/facets/actions/ActionMethodsFacetFactoryTest.java b/core/metamodel/src/test/java/org/apache/isis/core/metamodel/facets/actions/ActionMethodsFacetFactoryTest.java
index ecbb40c..e8a9122 100644
--- a/core/metamodel/src/test/java/org/apache/isis/core/metamodel/facets/actions/ActionMethodsFacetFactoryTest.java
+++ b/core/metamodel/src/test/java/org/apache/isis/core/metamodel/facets/actions/ActionMethodsFacetFactoryTest.java
@@ -41,7 +41,7 @@ import org.apache.isis.core.metamodel.facets.FacetedMethod;
import org.apache.isis.core.metamodel.facets.actions.defaults.ActionDefaultsFacet;
import org.apache.isis.core.metamodel.facets.actions.defaults.method.ActionDefaultsFacetViaMethod;
import org.apache.isis.core.metamodel.facets.actions.defaults.method.ActionDefaultsFacetViaMethodFactory;
-import org.apache.isis.core.metamodel.facets.actions.interaction.ActionNamedExplorationFacetFactory;
+import org.apache.isis.core.metamodel.facets.actions.interaction.ActionNamedFacetFactory;
import org.apache.isis.core.metamodel.facets.actions.prototype.PrototypeFacet;
import org.apache.isis.core.metamodel.facets.actions.validate.ActionValidationFacet;
import org.apache.isis.core.metamodel.facets.actions.validate.method.ActionValidationFacetViaMethod;
@@ -139,7 +139,7 @@ public class ActionMethodsFacetFactoryTest extends AbstractFacetFactoryTest {
}
public void testProvidesDefaultNameForActionButIgnoresAnyNamedAnnotation() {
- final ActionNamedExplorationFacetFactory facetFactory = new ActionNamedExplorationFacetFactory();
+ final ActionNamedFacetFactory facetFactory = new ActionNamedFacetFactory();
facetFactory.setServicesInjector(mockServicesInjector);
@@ -164,7 +164,7 @@ public class ActionMethodsFacetFactoryTest extends AbstractFacetFactoryTest {
public void testPicksUpExplorationPrefixAndSetsNameAppropriatelyAlso() {
- final ActionNamedExplorationFacetFactory facetFactory = new ActionNamedExplorationFacetFactory();
+ final ActionNamedFacetFactory facetFactory = new ActionNamedFacetFactory();
facetFactory.setServicesInjector(mockServicesInjector);
diff --git a/todo-deprecation-list.txt b/todo-deprecation-list.txt
index 0ee1f34..bebb90b 100644
--- a/todo-deprecation-list.txt
+++ b/todo-deprecation-list.txt
@@ -24,13 +24,6 @@ org.apache.isis.applib.services.memento (19 usages found)
-Also propose:
- make AppManifest mandatory
-
- remove support for contributed services (use mixins instead)
-
-
-
Also for 2.0.0, new features/deprecations:
automatically wrap domain services (perhaps behind a config property)
automatically infer \@Programmatic for all \@DomainService(nature=DOMAIN)
@@ -47,7 +40,6 @@ Also for 2.0.0, new features/deprecations:
OTHER STUFF:
-remove explorationXxx() prefix
remove prototypeXxx() prefix
remove debugXxx() prefix
@@ -150,6 +142,11 @@ org.apache.isis.applib.services.command
*************************************************************************
+DEPRECATED:
+
+ deprecate support for contributed services (use mixins instead)
+
+
DONE (ADDED)
new support for JSR-303 @Pattern annotation (http://beanvalidation.org/1.0/spec/, chapter 6) ... replaces @RegEx
@@ -162,13 +159,23 @@ DONE (MOVED)
org.apache.isis.applib.conmap.ContentMappingService to applib.services.conmap
-
DONE (REMOVED):
+ make AppManifest mandatory
+
removed support for Xxx.layout.json
- "reflector.layoutMetadataReaders" config prop
+ removed support for static method prefixes
+ * "notInServiceMenu"
+ * "named"
+ * "plural"
+ * "alwaysHide"
+ * "protect"
+ * "description"
+ * "optional"
+ remove explorationXxx() prefix
org.apache.isis.applib
@@ -490,10 +497,3 @@ org.apache.isis.viewer.restfulobjects.rendering.service.RepresentationServiceFor
- unused
-removed support for "notInServiceMenu" prefix
-removed named static method
-removed plural static method
-removed "alwaysHide" static
-removed "protect" static
-removed "description" static
-removed "optional" (if static)
--
To stop receiving notification emails like this one, please contact
"commits@isis.apache.org" <co...@isis.apache.org>.