vaulttec / isis-script Goto Github PK

View Code? Open in Web Editor NEW

8.0 6.0 2.0 4.1 MB

Isis Script is an Xtext-based DSL for generating Java code for the Apache Isis framework from a textual representation.

Home Page: http://vaulttec.org

License: Eclipse Public License 1.0

Java 14.84% Xtend 85.16%

dsl xtext xtend eclipse

isis-script's People

Contributors

Stargazers

Watchers

Forkers

mwhesse jifffffy

isis-script's Issues

outline view doesn't show child nodes for actions (though it does for properties)

I added a property:

@Property(optionality=OPTIONAL)
property Integer count {
    choices {
        #[1,2,3]
    }
}

and its "choices" node appears in the outline view, but the same is not true for the children of the "updateName" action:

@Action(domainEvent = UpdateNameDomainEvent)
action SimpleObject updateName {
    @Parameter(maxLength = 40)
    @ParameterLayout(named = "New name")
    parameter String newName {
        default {
            ...
        }
    }
    body {
        ...
    }
    validate {
                    ...
    }
    event UpdateNameDomainEvent
}

see:

Add template proposals

The Isis Script editor must provide code templates for the content assist.

Add support for generating a repository for an entity

From within an entity it should be possible to define the corresponding repository. If no repository name is specified then the plural entity name (created via the Evo Inflector) is used.

It'd be nice to use ctrl+shift+up/down to navigate the members in the Isis script editor

same as in Java editor.

Create a detailed description of the DSL

We need a documentation for the DSL which shows all of its features.

Replace deprecated DomainObjectContainer in generated code

In Isis version 1.12.0 the DomainObjectContainer service has been deprecated, replaced by a number of fine-grained services (such as RepositoryService and MessageService).

The corresponding migration guide can be found here.

Generate toString method for entities

For entities we could generate toString() methods similar to the compareTo() methods.

Automatically create a domain event hierarchy

If you look at the isis-app-todoapp or the isis-module-security addons, say, you'll see that I create a hierarchy of events... for the member, for the class, for the module. This is so that any subscribers on these events can choose the scope/granularity. (A subscriber at the module level could in essence veto all that module's functionality from the UI).

Perhaps the DSL could automatically generate this event hierarchy?

Provide additional outline view actions like JDTs "Go Into Top Level Type" and "Collapse All"

It would be helpful to filter the package name, the import section and the type name from the outline view - similar to JDTs "Go Into Top Level Type". And an outline view action to collapse all nodes would be great too.

derived properties not compiled

Improve formatter

The generated formatter stub has to be improved. A detailed explanation of the new formatter API can be found here.

The generated compareTo should use varargs version rather than CSV.

rather than:

@Override
 public int compareTo(final SimpleObject other) {
    return org.apache.isis.applib.util.ObjectContracts.compare(this, other, "name,count");
 }

should be:

@Override
public int compareTo(final SimpleObject other) {
  return org.apache.isis.applib.util.ObjectContracts.compare(this, other, "name","count");
}

Invalid "unused imports" warnings and invalid organize imports behaviour for service type annotations

Invalid "unused imports" warnings occur when using imports for service types, which also impacts the organize imports function of the DSL editor.

This is due to the wrong invocation of the XAnnotation rule in the Isis Script Xtext grammar as described in the Xtext bug #424775.

no viable alternative at input 'repository'

I'm trying the example given in the readme, and there seems to be an issue with the respository keyword.

In Ecliipse I am getting: "no viable alternative at input 'repository'".

I'm not sure if this is related, but I also see:

eclipse.buildId=4.5.0.I20150603-2000
java.version=1.8.0_45
java.vendor=Oracle Corporation
BootLoader constants: OS=linux, ARCH=x86_64, WS=gtk, NL=en_US
Framework arguments:  -product org.eclipse.epp.package.java.product
Command-line arguments:  -os linux -ws gtk -arch x86_64 -product org.eclipse.epp.package.java.product

org.apache.log4j
Error
Sun Jul 19 00:31:06 CEST 2015
org.eclipse.xtext.xbase.jvmmodel.JvmModelAssociator  - Error calling inferrer


java.lang.NullPointerException
    at org.vaulttec.isis.script.jvmmodel.IsisJvmModelInferrer._infer(IsisJvmModelInferrer.java:81)
    at org.vaulttec.isis.script.jvmmodel.IsisJvmModelInferrer.infer(IsisJvmModelInferrer.java:577)
    at org.eclipse.xtext.xbase.jvmmodel.JvmModelAssociator.installDerivedState(JvmModelAssociator.java:382)
    at org.eclipse.xtext.resource.DerivedStateAwareResource.installDerivedState(DerivedStateAwareResource.java:240)
    at org.eclipse.xtext.xbase.resource.BatchLinkableResource.getContents(BatchLinkableResource.java:148)
    at org.eclipse.xtext.xbase.typesystem.internal.LogicalContainerAwareBatchTypeResolver.getEntryPoints(LogicalContainerAwareBatchTypeResolver.java:44)
    at org.eclipse.xtext.xbase.typesystem.internal.DefaultBatchTypeResolver.getTypeResolver(DefaultBatchTypeResolver.java:63)
    at org.eclipse.xtext.xbase.typesystem.internal.CachingBatchTypeResolver$1.get(CachingBatchTypeResolver.java:49)
    at org.eclipse.xtext.xbase.typesystem.internal.CachingBatchTypeResolver$1.get(CachingBatchTypeResolver.java:1)
    at org.eclipse.xtext.util.OnChangeEvictingCache.get(OnChangeEvictingCache.java:77)
    at org.eclipse.xtext.xbase.typesystem.internal.CachingBatchTypeResolver.doResolveTypes(CachingBatchTypeResolver.java:46)
    at org.eclipse.xtext.xbase.typesystem.internal.AbstractBatchTypeResolver.resolveTypes(AbstractBatchTypeResolver.java:69)
    at org.eclipse.xtext.xbase.resource.BatchLinkingService.resolveBatched(BatchLinkingService.java:71)
    at org.eclipse.xtext.xbase.resource.BatchLinkableResource.resolveLazyCrossReferences(BatchLinkableResource.java:165)
    at org.eclipse.xtext.EcoreUtil2.resolveLazyCrossReferences(EcoreUtil2.java:528)
    at org.eclipse.xtext.ui.editor.reconciler.XtextDocumentReconcileStrategy.postParse(XtextDocumentReconcileStrategy.java:174)
    at org.eclipse.xtext.ui.editor.reconciler.XtextDocumentReconcileStrategy.doReconcile(XtextDocumentReconcileStrategy.java:152)
    at org.eclipse.xtext.ui.editor.reconciler.XtextDocumentReconcileStrategy.reconcile(XtextDocumentReconcileStrategy.java:66)
    at org.eclipse.xtext.ui.editor.reconciler.XtextReconciler.doRun(XtextReconciler.java:445)
    at org.eclipse.xtext.ui.editor.reconciler.XtextReconciler.access$3(XtextReconciler.java:425)
    at org.eclipse.xtext.ui.editor.reconciler.XtextReconciler$DocumentListener$1.exec(XtextReconciler.java:136)
    at org.eclipse.xtext.ui.editor.reconciler.XtextReconciler$DocumentListener$1.exec(XtextReconciler.java:1)
    at org.eclipse.xtext.resource.OutdatedStateManager.exec(OutdatedStateManager.java:121)
    at org.eclipse.xtext.ui.editor.model.XtextDocument$XtextDocumentLocker.modify(XtextDocument.java:428)
    at org.eclipse.xtext.ui.editor.model.XtextDocument$XtextDocumentLocker.process(XtextDocument.java:337)
    at org.eclipse.xtext.ui.editor.reconciler.XtextReconciler$DocumentListener.performNecessaryUpdates(XtextReconciler.java:133)
    at org.eclipse.xtext.ui.editor.model.XtextDocument.updateContentBeforeRead(XtextDocument.java:249)
    at org.eclipse.xtext.ui.editor.model.XtextDocument$XtextDocumentLocker.internalReadOnly(XtextDocument.java:518)
    at org.eclipse.xtext.ui.editor.model.XtextDocument$XtextDocumentLocker.readOnly(XtextDocument.java:492)
    at org.eclipse.xtext.ui.editor.model.XtextDocument.readOnly(XtextDocument.java:133)
    at org.eclipse.xtext.ui.editor.syntaxcoloring.HighlightingReconciler$2.run(HighlightingReconciler.java:320)
    at org.eclipse.core.internal.jobs.Worker.run(Worker.java:55)

Name collision of tokens and Collection operations

@mwhesse reported a name collision of the tokens add and remove with the corresponding operations of the Collection type.

For resolving this name clash these tokens will be renamed to addTo and removeFrom as defined in ISIS-369.

Error trying to use eclipse plugin

This looks like a really excellent plugin. I was just thinking that it would be interesting to do a sculptor cartridge for Apache Isis, then found this.

Anyway, when trying to run it, I am not getting eclipe recognize the .isis extension, and get the below error:

eclipse.buildId=4.5.0.I20150603-2000
java.version=1.7.0_79
java.vendor=Oracle Corporation
BootLoader constants: OS=linux, ARCH=x86_64, WS=gtk, NL=en_US
Framework arguments: -product org.eclipse.epp.package.java.product
Command-line arguments: -data file:/home/anton/workspaces/tradeworks-modeling/ -os linux -ws gtk -arch x86_64 -product org.eclipse.epp.package.java.product

org.vaulttec.isis.script.ui
Error
Sat Jul 18 00:18:32 CEST 2015
FrameworkEvent ERROR

org.osgi.framework.BundleException: Could not resolve module: org.vaulttec.isis.script.ui [1821]
Unresolved requirement: Require-Capability: osgi.ee; filter:="(&(osgi.ee=JavaSE)(version=1.8))"

at org.eclipse.osgi.container.Module.start(Module.java:434)
at org.eclipse.osgi.container.ModuleContainer$ContainerStartLevel.incStartLevel(ModuleContainer.java:1582)
at org.eclipse.osgi.container.ModuleContainer$ContainerStartLevel.incStartLevel(ModuleContainer.java:1561)
at org.eclipse.osgi.container.ModuleContainer$ContainerStartLevel.doContainerStartLevel(ModuleContainer.java:1533)
at org.eclipse.osgi.container.ModuleContainer$ContainerStartLevel.dispatchEvent(ModuleContainer.java:1476)
at org.eclipse.osgi.container.ModuleContainer$ContainerStartLevel.dispatchEvent(ModuleContainer.java:1)
at org.eclipse.osgi.framework.eventmgr.EventManager.dispatchEvent(EventManager.java:230)
at org.eclipse.osgi.framework.eventmgr.EventManager$EventThread.run(EventManager.java:340)

eclipse.buildId=4.5.0.I20150603-2000
java.version=1.7.0_79
java.vendor=Oracle Corporation
BootLoader constants: OS=linux, ARCH=x86_64, WS=gtk, NL=en_US
Framework arguments: -product org.eclipse.epp.package.java.product
Command-line arguments: -data file:/home/anton/workspacesmodeling/ -os linux -ws gtk -arch x86_64 -product org.eclipse.epp.package.java.product

Suggestion to give isis-script a snappier name...

We chose "Isis" as the name of the framework because the original authors lived (still live) in Oxfordshire, and the River Thames is called Isis when it flows through Oxford.

So, in thinking about the name of a language for Isis, I hit upon a bad pun that "source" is a "source programming language" but also the "source of a river". The source of the River Thames is officially a place called Thames_Head, which isn't much of a name, but it's very close to a village called Kemble, which is (I think) a great name.

https://en.wikipedia.org/wiki/Thames_Head

Thoughts?

Could the generated Java source be shown as a tab of the .isis editor?

Similar to how a pom.xml has different tabs?

Further features for IDE

Many years ago I wrote some Eclipse plugins of my own for the Naked Objects framework (precursor to Apache Isis). None of that code is salvageable, but perhaps some of the ideas I implemented could be brought into isis-script.

Screenshot below:

Add default annotations if not present

All the Isis Script elements must get a default Isis annotation if no annotation is defined in the DSL.

Migrate to new generator architecture introduced in Xtext 2.9

In Xtext 2.9 an new generator architecture was introduced. The process of migrating to the new architecture is outlined here.

TogetherJ-like support? (class diagrams)

I originally got into Apache Isis by way of (the sadly departed) TogetherJ ... I'd coauthored a book on the topic over a decade ago [1]

So... this is a big ask, but it'd be wonderful to be able to enhance the Eclipse plugin to provide way to visualize a domain (or subset thereof) as a class diagram of some sort or other.

[1] http://www.amazon.co.uk/Better-Software-Faster-Coad-Carmichael/dp/0130087521

public class SimpleObjectsTest {

    @Mock
    DomainObjectContainer mockContainer;
    SimpleObjects simpleObjects;

    @Before
    public void setUp() throws Exception {
        simpleObjects = new SimpleObjects();
        
        //simpleObjects.container = mockContainer;
        Field field = simpleObjects.getClass().getField("container");
        field.set(simpleObjects, mockContainer);
    }

Update to Xtext 2.11

Version 2.11 of Xtext / Xtend is released (bug list).

Starting with version 2.11 Xtext requires Java 8 as execution environment. The minimal supported target platform is Eclipse Luna.