spring-gen 0.1.0

data/README.md

@@ -0,0 +1,133 @@
+# spring-gen
+
+spring-gen is a rails-like generator for spring microservices.
+
+## Installation
+Open a terminal and type 
+```bash
+gem install lectureGen
+```
+
+
+
+## Usage
+
+First, create a new microservice:
+
+```bash
+spring-gen service com.mycompany.MyService
+#output
+      create  MyService/config
+      create  MyService/config/checkstyle/checkstyle.xml
+      create  MyService/config/codestyle/Codestyle.xml
+      create  MyService/config/copyright/gnu.xml
+      create  MyService/config/copyright/profiles_settings.xml
+      create  MyService/src/main/java/com/mycompany/main/App.java
+      create  MyService/src/main/java/com/mycompany/config/AppConfig.java
+      create  MyService/.gitignore
+      create  MyService/src/main/resources/application.yml
+      create  MyService/src/main/resources/bootstrap.yml
+      create  MyService/build.gradle
+      create  MyService/service.yml
+```
+This will create a jpa based microservice. The service command expects an argument in the form `groupId.artifactId`.
+So the argument `com.mycompany.MyService` will get interpreted as groupId: com.mycompany and artifactId: MyService.
+
+You can specify a different spring-data  backend with the `r` option:
+
+```bash
+spring-gen service com.mycompany.MyService -r mongodb
+#output
+      create  MyService/config
+      create  MyService/config/checkstyle/checkstyle.xml
+      create  MyService/config/codestyle/Codestyle.xml
+      create  MyService/config/copyright/gnu.xml
+      create  MyService/config/copyright/profiles_settings.xml
+      create  MyService/src/main/java/com/mycompany/main/App.java
+      create  MyService/src/main/java/com/mycompany/config/AppConfig.java
+      create  MyService/.gitignore
+      create  MyService/src/main/resources/application.yml
+      create  MyService/src/main/resources/bootstrap.yml
+      create  MyService/build.gradle
+      create  MyService/service.yml
+```
+
+with mongodb as a backend, different classes will be generated. spring-gen currently supports
+jpa, mongodb and neo4j.
+
+After creating the project layout, enter the project-root and generate some resources:
+
+```bash
+cd MyService
+spring-gen resource User firstname:String lastname:String
+#output
+      create  src/test/resources/sampledata/userSampleData.xml
+      create  src/main/java/com/mycompany/model/BaseEntity.java
+      create  src/main/java/com/mycompany/model/User.java
+      create  src/main/java/com/mycompany/repository/UserRepository.java
+      create  src/test/java/com/mycompany/integration/user/UserIntegrationTestConfig.java
+      create  src/test/java/com/mycompany/integration/user/UserIntegrationTest.java
+      create  src/test/java/util/TestUtil.java
+```
+This will generate a new user-model (containing string attributes for firstname and lastname)
+as well as a repository that matches your spring-data choice. spring-gen will assume that you use
+spring-data-rest. If you don't want to use spring-data-rest you can set the --full option,
+which will generate additional classes like REST-controllers:
+
+```bash
+spring-gen resource User firstname:String lastname:String --full
+# output
+      create  src/test/resources/sampledata/userSampleData.xml
+      create  src/main/java/com/mycompany/model/BaseEntity.java
+      create  src/main/java/com/mycompany/model/User.java
+      create  src/main/java/com/mycompany/repository/UserRepository.java
+      create  src/test/java/com/mycompany/integration/user/UserIntegrationTestConfig.java
+      create  src/test/java/com/mycompany/integration/user/UserIntegrationTest.java
+      create  src/test/java/util/TestUtil.java
+      create  src/test/java/com/mycompany/unit/user/controller/UserControllerUnitTestConfig.java
+      create  src/test/java/com/mycompany/unit/user/controller/UserControllerUnitTest.java
+      create  src/test/java/com/mycompany/unit/user/assembler/UserAssemblerUnitTestConfig.java
+      create  src/test/java/com/mycompany/unit/user/assembler/UserAssemblerUnitTest.java
+      create  src/main/java/com/mycompany/controller/BaseController.java
+      create  src/main/java/com/mycompany/controller/UserController.java
+      create  src/main/java/com/mycompany/assembler/BaseAssembler.java
+      create  src/main/java/com/mycompany/assembler/UserAssembler.java
+      create  src/main/java/com/mycompany/resource/UserResource.java
+      create  src/main/java/com/mycompany/exception/NotCreatedException.java
+```
+
+
+
+
+## Issues
+
+Neo4j is not really working right now. This will get resolved after SDN4 hits the spot.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/Richterrettich/spring-gen/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## Copyright
+Copyright (c) 2015 Rene Richter.
+slidemgr is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software Foundation,
+Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/spring-gen

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'command_router'
+require 'thor'
+
+
+CommandRouter::Main.start ARGV

data/lib/command_router.rb

@@ -0,0 +1,15 @@
+require 'commands/resource'
+require "commands/service"
+require 'thor'
+
+module CommandRouter
+  include Util
+
+  class Main < Thor
+
+    register(Service, 'service', 'service [service_name]', 'Creates a new microservice.')
+    register(Resource, 'resource', 'resource [resource_name]', 'Creates a new resource')
+
+  end
+
+end

data/lib/commands/resource.rb

@@ -0,0 +1,129 @@
+require 'thor'
+require 'thor/group'
+require 'util'
+
+Attribute = Struct.new(:name,:data_type)
+class Resource < Thor::Group
+  include Util
+  include Thor::Actions
+
+  argument :model_name, :type => :string, :desc => 'Name of the model'
+  argument :attributes,
+           :type => :hash,
+           :desc => 'attributes',
+           :default => {}
+
+  class_option :full,
+               :type => :boolean,
+               :desc => 'invoke all templates',
+               :aliases => 'f',
+               :default => false
+
+  def self.source_root
+    File.expand_path('../',__dir__)
+  end
+
+  def prepare_attributes
+    @attributes = @attributes.map{|k,v| Attribute.new k,v}
+  end
+
+  def create_model
+    @user_name = user_name
+    @user_email = user_email
+    @group_id = config.group_id
+    @artifact_id = config.artifact_id
+    @full = options['full']
+
+
+    case config.repository_technique
+      when "jpa"
+        @repository_import = "jpa.repository.JpaRepository"
+        @repository_type = "JpaRepository<#{@model_name},Long>"
+        @entity_annotation = "@Entity"
+        @annotation_import = "import javax.persistence.Entity;"
+        template "templates/resource/test/integration/#{config.repository_technique}/sampleData.xml.erb",
+                 "#{content_root}/src/test/resources/sampledata/#{@model_name.downcase}SampleData.xml"
+      when "mongodb"
+        @repository_import = "mongodb.repository.MongoRepository"
+        @repository_type = "MongoRepository<#{@model_name},Long>"
+        @annotation_import = 'import org.springframework.data.mongodb.core.mapping.Document;'
+        @entity_annotation = "@Document"
+        template "templates/resource/test/integration/#{config.repository_technique}/SampleData.java.erb",
+                 "#{content_root}/src/test/java/#{@group_id.gsub(".","/")}/integration/#{@model_name.downcase}/#{@model_name}SampleData.java"
+      when "neo4j"
+        @repository_import = "neo4j.repository.GraphRepository"
+        @repository_type = "GraphRepository<#{@model_name}>"
+        @entity_annotation = "@NodeEntity"
+        template "templates/resource/test/integration/#{config.repository_technique}/SampleData.java.erb",
+                 "#{content_root}/src/test/java/#{@group_id.gsub(".","/")}/integration/#{@model_name.downcase}/#{@model_name}SampleData.java"
+      else
+        raise ("not a suitable repository-technique.")
+    end
+
+
+    template "templates/resource/model/#{config.repository_technique.capitalize}BaseEntity.java.erb",
+             "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/model/BaseEntity.java"
+    template(
+      'templates/resource/model/Model.java.erb',
+      "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/model/#{@model_name}.java")
+
+    template(
+        'templates/resource/repository/Repository.java.erb',
+        "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/repository/#{@model_name}Repository.java")
+
+    template(
+        "templates/resource/test/integration/#{config.repository_technique}/IntegrationTestConfig.java.erb",
+        "#{content_root}/src/test/java/#{@group_id.gsub(".","/")}/integration/#{@model_name.downcase}/#{@model_name}IntegrationTestConfig.java")
+
+    template(
+        "templates/resource/test/integration/#{config.repository_technique}/IntegrationTest.java.erb",
+        "#{content_root}/src/test/java/#{@group_id.gsub(".","/")}/integration/#{@model_name.downcase}/#{@model_name}IntegrationTest.java")
+
+
+    template(
+        'templates/resource/test/TestUtil.java.erb',
+        "#{content_root}/src/test/java/util/TestUtil.java") unless File.exist?("#{content_root}/src/test/java/util/TestUtil.java")
+
+    if @full
+
+      template(
+          'templates/resource/test/unit/controller/ControllerUnitTestConfig.java.erb',
+          "#{content_root}/src/test/java/#{@group_id.gsub(".","/")}/unit/#{@model_name.downcase}/controller/#{@model_name}ControllerUnitTestConfig.java")
+
+      template(
+          'templates/resource/test/unit/controller/ControllerUnitTest.java.erb',
+          "#{content_root}/src/test/java/#{@group_id.gsub(".","/")}/unit/#{@model_name.downcase}/controller/#{@model_name}ControllerUnitTest.java")
+
+      template(
+          'templates/resource/test/unit/assembler/AssemblerUnitTestConfig.java.erb',
+          "#{content_root}/src/test/java/#{@group_id.gsub(".","/")}/unit/#{@model_name.downcase}/assembler/#{@model_name}AssemblerUnitTestConfig.java")
+
+      template(
+          'templates/resource/test/unit/assembler/AssemblerUnitTest.java.erb',
+          "#{content_root}/src/test/java/#{@group_id.gsub(".","/")}/unit/#{@model_name.downcase}/assembler/#{@model_name}AssemblerUnitTest.java")
+
+
+      template 'templates/resource/controller/BaseController.java.erb',
+                "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/controller/BaseController.java"  unless File.exist?("#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/controller/BaseController.java")
+
+      template(
+          'templates/resource/controller/Controller.java.erb',
+          "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/controller/#{@model_name}Controller.java")
+
+      template 'templates/resource/assembler/BaseAssembler.java.erb',
+                "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/assembler/BaseAssembler.java" unless File.exist?("#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/assembler/BaseAssembler.java")
+      template(
+          'templates/resource/assembler/Assembler.java.erb',
+          "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/assembler/#{@model_name}Assembler.java")
+
+      template(
+          'templates/resource/resource/Resource.java.erb',
+          "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/resource/#{@model_name}Resource.java")
+
+      template 'templates/resource/exception/NotCreatedException.java.erb',
+                "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/exception/NotCreatedException.java" unless File.exist? "#{content_root}/src/main/java/#{@group_id.gsub(".","/")}/exception/NotCreatedException.java"
+
+    end
+  end
+
+end

data/lib/commands/service.rb

@@ -0,0 +1,53 @@
+require 'thor/group'
+require 'thor'
+require 'git'
+
+
+class Service < Thor::Group
+  include Thor::Actions
+
+  argument :name, :type => :string, :desc => 'Microservice name'
+
+  class_option :repository_technique,
+               :type => :string,
+               :desc => 'repository technique',
+               :aliases => 'r',
+               :required => false
+
+  def self.source_root
+    File.expand_path('../',__dir__)
+  end
+
+  def prepare_artifact
+    parts = @name.split(".")
+    @name = @artifact_id = parts.pop
+    @group_id = parts.length > 0 ?  parts.join('.') : @name
+  end
+
+  def init_git
+    g = Git.init @name
+    @user_name = g.config['user.name']
+    @user_email = g.config['user.email']
+  end
+
+  # TODO evtl. für andere entwicklugnsumgebungen erweitern.
+
+  def create_layout
+
+    @repository_technique = options['repository_technique'] || 'jpa'
+
+    #TODO templates vervollständigen.
+    directory 'templates/layout/intellij/config',"#{@name}/config"
+
+    template 'templates/layout/src/java/main/App.java.erb',"#{@name}/src/main/java/#{@group_id.gsub(".","/")}/main/App.java"
+    template 'templates/layout/src/java/config/AppConfig.java.erb',"#{@name}/src/main/java/#{@group_id.gsub(".","/")}/config/AppConfig.java"
+    copy_file 'templates/layout/.gitignore',"#{@name}/.gitignore"
+    template 'templates/layout/src/resources/application.yml.erb',"#{@name}/src/main/resources/application.yml"
+    template 'templates/layout/src/resources/bootstrap.yml.erb',"#{@name}/src/main/resources/bootstrap.yml"
+    template 'templates/layout/build.gradle.erb',"#{@name}/build.gradle"
+    template 'templates/service.yml.erb',"#{@name}/service.yml"
+  end
+
+
+
+end

data/lib/spring-gen/version.rb

@@ -0,0 +1,3 @@
+module SpringGen
+  VERSION = "0.1.0"
+end

data/lib/spring-gen.rb

@@ -0,0 +1,5 @@
+require "spring-gen/version"
+
+module SpringGen
+  # Your code goes here...
+end

data/lib/templates/layout/.gitignore

@@ -0,0 +1,36 @@
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion
+*.iml
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+**/.DS_store
+
+build/*
+
+.gradle
+
+testdb/*
+
+**/testdb/*
+
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties

data/lib/templates/layout/build.gradle.erb

@@ -0,0 +1,105 @@
+/*
+* Copyright (c) 2015 <%=@user_name%>.
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; either version 3 of the License, or
+* (at your option) any later version.
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+* You should have received a copy of the GNU General Public License
+* along with this program; if not, write to the Free Software Foundation,
+* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
+*/
+
+buildscript {
+  repositories {
+    mavenCentral()
+  }
+  dependencies {
+    classpath("org.springframework.boot:spring-boot-gradle-plugin:1.2.3.RELEASE")
+  }
+}
+
+repositories {
+  mavenCentral()
+
+  maven {
+    url 'http://repo.spring.io/libs-snapshot-continuous-local'
+  }
+  maven {
+    url 'http://maven.springframework.org/milestone/'
+  }
+
+  maven {
+    url 'http://repo.spring.io/libs-snapshot'
+  }
+
+
+
+}
+
+
+apply plugin: 'java'
+apply plugin: 'idea'
+apply plugin: 'spring-boot'
+apply plugin: "checkstyle"
+
+checkstyle{
+  checkstyle {
+    toolVersion = "6.6"
+  }
+}
+
+task checkstyle(type: Checkstyle) {
+  configFile file("config/checkstyle/checkstyle.xml")
+  source './'
+  include '**/*.java'
+  classpath = files()
+}
+
+
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+
+dependencies {
+  compile("org.springframework.boot:spring-boot-starter-web")
+  compile("org.springframework.boot:spring-boot-starter-tomcat")
+  compile("org.springframework.boot:spring-boot-starter-data-rest")
+  compile("org.springframework.boot:spring-boot-starter-data-<%=@repository_technique%>")
+
+
+  compile("org.springframework.amqp:spring-rabbit")
+
+  compile 'org.springframework.cloud:spring-cloud-starter-eureka:1.0.1.RELEASE'
+
+  compile 'org.springframework.hateoas:spring-hateoas'
+
+  compile 'org.apache.commons:commons-lang3:3.4'
+
+  <%if @repository_technique == "jpa"%>
+    compile 'com.h2database:h2:1.4.187'
+    testCompile "org.dbunit:dbunit:2.5.0"
+    testCompile "com.github.springtestdbunit:spring-test-dbunit:1.2.1"
+  <%elsif @repository_technique == "mongodb"%>
+    testCompile 'com.github.fakemongo:fongo:1.6.2'
+  <%elsif @repository_technique == "neo4j"%>
+
+  <%end%>
+
+
+  testCompile "org.springframework:spring-test:4.1.6.RELEASE"
+  testCompile "org.mockito:mockito-core:1.9.5"
+  testCompile "org.hamcrest:hamcrest-all:1.3"
+  testCompile "com.jayway.jsonpath:json-path-assert:2.0.0"
+  testCompile("junit:junit")
+
+
+
+}
+
+task wrapper(type: Wrapper) {
+gradleVersion = '2.3'
+}