liquigen 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 828dd9e9045d6e0c612b17f2919d0d23573d3ccade3d7a665bde8abe6b889302
-  data.tar.gz: 362285b1394e2f66155d596a72330de7a7e62cbacf8fa2bc08096c16da1b5277
+  metadata.gz: d0d16f3716ac42fa44b15400554b51c938036fed31b37c32672db386ab7d0312
+  data.tar.gz: d1257fdaa9d7ab05bbd9b28254ffcba14b32f41bf921aa0685ac60a3e21f55d8
 SHA512:
-  metadata.gz: f1db59837bafb0cc1d511ddb086ebee6a09f944d2f99fce5ab12199cfb8c2f51c966710c28c774d2aee85a0d0b5236c8b069e9b83081db836e06f426d29578a5
-  data.tar.gz: 2e9352ce87d00eb6cd02690859dfbe1c2a5b52c2944219c3b04aa8ee0b0109099dbc7abbf20aa83ee9570cc6cd33cf76efcdefe1d0a908957b7d97859dad51e4
+  metadata.gz: 6d9827759f31f7078d784128ea525e39b437dfb6228bec425c26ae11c12d98406cfa7586ddf281882bd1603ba41a97eb4777a0db71b95b101f2c55e051c91ca8
+  data.tar.gz: ad268de9cecdfc004858e4d8bedae5562ab4d0df2ec8dda9fdc995a41a65282c8ad550edc5f52cb8da3c4941fc7c01186fbbe4855e704fd61df004455d730abd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    liquigen (0.0.3)
+    liquigen (0.1.0)
       activesupport
       gli (= 2.18.0)
 
@@ -24,7 +24,7 @@ GEM
     builder (3.2.3)
     childprocess (0.9.0)
       ffi (~> 1.0, >= 1.0.11)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.3)
     contracts (0.16.0)
     cucumber (3.1.2)
       builder (>= 2.1.2)

data/README.md

@@ -161,6 +161,26 @@ liquigen add_index -t user name:string email:string
 liquigen sql "update users set column=true" "update customers set x = 1"
 ```
 
+## config
+Which is used for scaffolding java codes. In your application directory, one file called '.liquigen' will be added.
+```bash
+liquigen config
+```
+
+Please specify your custom name and path:
+* package_name=com.yourpackage
+* java_codes_root=src/main/java
+* migration_path=src/main/resources/db/migrations
+* controller_package_name=
+* entity_package_name=
+* repository_package_name=
+
+## scaffold
+```bash
+liquigen scaffold -t table --controller --repository id:integer name:string email:string
+# Get help by typing liquigen scaffold --help
+```
+
 ## How to let the liquibase use migration directory
 
 * In your java project, open application.yml, add the following lines:

data/bin/liquigen

@@ -20,8 +20,16 @@ class App
   subcommand_option_handling :normal
   arguments :strict
 
+  desc 'Edit config file'
+  arg_name 'no argument'
+  command :config do |c|
+    c.action do
+      Liquigen::Scaffold::Config.new.process
+    end
+  end
+
   desc 'add table script'
-  arg_name 'Describe arguments to add_table here'
+  arg_name 'properties pair like id:integer'
   long_desc %{
     Example
     liquigen add_table -t user id:integer name:string
@@ -134,12 +142,53 @@ class App
     end
   end
 
+  desc 'Ping the current config'
+  arg_name 'No argument'
+  command :ping do |c|
+    c.action do
+      p "package name: #{Liquigen.package_name}"
+      p "controller_package_name: #{Liquigen.controller_package_name}"
+      p "entity_package_name: #{Liquigen.entity_package_name}"
+      p "repository_package_name: #{Liquigen.repository_package_name}"
+      p "java_codes_root: #{Liquigen.java_codes_root}"
+      p "migration_path: #{Liquigen.migration_path}"
+    end
+  end
+
+  desc 'Scaffod the java classes'
+  arg_name 'properties like id:integer, name:string'
+  command :scaffold do |c|
+    c.desc 'model name'
+    c.default_value 'model'
+    c.flag :n
+
+    c.desc 'generating the entity'
+    c.default_value true
+    c.switch :entity
+
+    c.desc 'generating the controller'
+    c.default_value false
+    c.switch :controller
+
+    c.desc 'generating the repository'
+    c.default_value false
+    c.switch :repository
+
+    c.action do |_, options, args|
+      Liquigen::Scaffold::Entity.new(options[:n], args).process if options[:entity]
+      Liquigen::Scaffold::Controller.new(options[:n], args).process if options[:controller]
+      Liquigen::Scaffold::Repository.new(options[:n], args).process if options[:repository]
+    end
+  end
+
   pre do |global, command, options, args|
     # Pre logic here
     # Return true to proceed; false to abort and not call the
     # chosen command
     # Use skips_pre before a command to skip this block
     # on that command only
+    Liquigen.load
+
     true
   end
 

data/lib/liquigen.rb

@@ -27,5 +27,54 @@ require 'liquigen/handlers/sql'
 require 'liquigen/handlers/add_index'
 require 'liquigen/handlers/drop_table'
 
+require 'liquigen/scaffold/config'
+require 'liquigen/scaffold/base'
+require 'liquigen/scaffold/controller'
+require 'liquigen/scaffold/entity'
+require 'liquigen/scaffold/repository'
+
 # Add requires for other files you add to your project here, so
-# you just need to require this one file in your bin file
+# you just need to require this one file in your bin file
+
+module Liquigen
+  class << self
+    attr_accessor :package_name
+    # default value: #{package_name}.controller
+    attr_accessor :controller_package_name
+    # default value: #{package_name}.model
+    attr_accessor :entity_package_name
+    # default value: #{package_name}.repository
+    attr_accessor :repository_package_name
+    # default value: src/main/java
+    attr_accessor :java_codes_root
+    # default value: src/main/resources/db/migrations
+    attr_accessor :migration_path
+
+    def load_default
+      self.package_name ||= 'com.package'
+      self.controller_package_name ||= "#{package_name}.controller"
+      self.entity_package_name ||= "#{package_name}.model"
+      self.repository_package_name ||= "#{package_name}.repository"
+      self.java_codes_root ||= 'src/main/java'
+      self.migration_path ||= 'src/main/resources/db/migrations'
+    end
+
+    def load
+      load_lines File.readlines(Liquigen::Scaffold::CONFIG_FILE) if File.exist?(Liquigen::Scaffold::CONFIG_FILE)
+
+      load_default
+    end
+
+    def load_lines(lines)
+      lines.each do |line|
+        next if line.strip.start_with? '#'
+        next if line.strip.size.zero?
+
+        assignment = line.split('=')
+        name = "#{assignment[0]&.strip}="
+
+        Liquigen.send(name, assignment[1]&.strip) if Liquigen.singleton_methods.include?(name.to_sym)
+      end
+    end
+  end
+end

data/lib/liquigen/handlers/base.rb

@@ -48,11 +48,9 @@ module Liquigen::Handlers
     end
 
     def build_file_name
-      dir = 'src/main/resources/db/migrations'
+      FileUtils.mkdir_p(Liquigen.migration_path)
 
-      FileUtils.mkdir_p(dir)
-
-      "#{dir}/#{id}.yaml"
+      "#{Liquigen.migration_path}/#{id}.yaml"
     end
 
     def process_lines(file_path)

data/lib/liquigen/scaffold/base.rb

@@ -0,0 +1,61 @@
+module Liquigen::Scaffold
+  class Base
+    attr_accessor :name
+    attr_accessor :props
+
+    def initialize(name, props)
+      self.name = name
+      self.props = props
+    end
+
+    def process
+      file = "#{directory}/#{file_name}"
+      return if File.exist? file
+
+      lines = []
+      lines += import_lines
+      lines += []
+      lines += class_lines
+      lines += []
+      lines += methods_lines
+      lines += ['}']
+
+      File.open(file, 'w') do |f|
+        f.write lines.join("\n")
+      end
+    end
+
+    def current_package
+      Liquigen.package_name
+    end
+
+    def directory
+      "#{Liquigen.java_codes_root}/#{current_package.split('.').join('/')}"
+    end
+
+    def file_name
+      "#{name.singularize.camelize}#{file_append}.java"
+    end
+
+    def file_append
+      ''
+    end
+
+    def write_lines(file, lines = [])
+      file.write lines.join("\n")
+      file.write("\n")
+    end
+
+    def import_lines
+      []
+    end
+
+    def class_lines
+      []
+    end
+
+    def methods_lines
+      []
+    end
+  end
+end

data/lib/liquigen/scaffold/config.rb

@@ -0,0 +1,25 @@
+module Liquigen::Scaffold
+  CONFIG_FILE = '.liquigen'.freeze
+  class Config
+    # write config file
+    def process
+      # if not exist the .liquigen file create it
+      File.write(CONFIG_FILE, prepare_default_content.join("\n")) unless File.exist?(CONFIG_FILE)
+
+      # then open the vim editor
+      system('vi ' + CONFIG_FILE)
+    end
+
+    def prepare_default_content
+      contents = []
+      contents << '# You can remove the # to set your custom value'
+      contents << '# package_name=your-package-name, required'
+      contents << '# java_codes_root=src/main/java'
+      contents << '# migration_path=src/main/resources/db/migrations'
+      contents << '# controller_package_name='
+      contents << '# entity_package_name='
+      contents << '# repository_package_name='
+      contents << ''
+    end
+  end
+end

data/lib/liquigen/scaffold/controller.rb

@@ -0,0 +1,45 @@
+module Liquigen::Scaffold
+  class Controller < Base
+    def current_package
+      Liquigen.controller_package_name
+    end
+
+    def file_append
+      'Controller'
+    end
+
+    def file_name
+      "#{name.pluralize.camelize}#{file_append}.java"
+    end
+
+    def import_lines
+      [
+        "package #{current_package};",
+        '',
+        "import #{Liquigen.entity_package_name}.#{name.singularize.camelize};",
+        "import #{Liquigen.repository_package_name}.#{name.camelize}Repository;",
+        'import org.springframework.beans.factory.annotation.Autowired;',
+        'import org.springframework.web.bind.annotation.RequestMapping;',
+        'import org.springframework.web.bind.annotation.RestController;',
+        ''
+      ]
+    end
+
+    def class_lines
+      [
+        '@RestController',
+        "@RequestMapping(\"/#{name.underscore.pluralize}\")",
+        "public class #{name.pluralize.camelize}#{file_append} extends ControllerBase<#{name.singularize.camelize}, #{name.singularize.camelize}Repository> {"
+      ]
+    end
+
+    def methods_lines
+      [
+        '@Autowired',
+        "public #{name.pluralize.camelize}#{file_append}(#{name.singularize.camelize}Repository repository) {",
+        'this.repository = repository;',
+        '}'
+      ]
+    end
+  end
+end

data/lib/liquigen/scaffold/entity.rb

@@ -0,0 +1,50 @@
+require 'liquigen/type_map'
+
+module Liquigen::Scaffold
+  class Entity < Base
+    def current_package
+      Liquigen.entity_package_name
+    end
+
+    def import_lines
+      [
+        "package #{current_package};",
+        'import com.fasterxml.jackson.annotation.*;',
+        'import com.fasterxml.jackson.databind.annotation.JsonDeserialize;',
+        'import lombok.Getter;',
+        'import lombok.Setter;',
+        'import lombok.experimental.Accessors;',
+        'import javax.persistence.*;',
+        'import java.util.List;',
+        ''
+      ]
+    end
+
+    def class_lines
+      [
+        '@Entity',
+        '@Getter',
+        '@Setter',
+        '@Accessors(chain = true)',
+        "@Table(name = \"#{name.underscore.pluralize}\")",
+        "public class #{name.singularize.camelize} extends ModelBase {"
+      ]
+    end
+
+    def methods_lines
+      lines = []
+      skip_ones = %w[id created_time updated_time]
+      props.map do |property|
+        key, value = property.split(':')
+        next if skip_ones.include?(key.underscore)
+
+        lines += [
+                    '@Column(nullable = false)',
+                    '@JsonProperty',
+                    "private #{Liquigen::TypeMap.new(value).java_type} #{key.camelize};",
+                    ''
+                  ]
+      end
+    end
+  end
+end

data/lib/liquigen/scaffold/repository.rb

@@ -0,0 +1,31 @@
+module Liquigen::Scaffold
+  class Repository < Base
+    def current_package
+      Liquigen.repository_package_name
+    end
+
+    def file_append
+      'Repository'
+    end
+
+    def import_lines
+      [
+        "package #{current_package};",
+        "import #{Liquigen.entity_package_name}.#{name.singularize.camelize};",
+        'import org.springframework.stereotype.Repository;',
+        ''
+      ]
+    end
+
+    def class_lines
+      [
+        '@Repository',
+        "public interface #{name.singularize.camelize}#{file_append} extends IRepository<#{name.singularize.camelize}, Long> {"
+      ]
+    end
+
+    def methods_lines
+      []
+    end
+  end
+end

data/lib/liquigen/type_map.rb

@@ -2,6 +2,7 @@ module Liquigen
   class TypeMap
     attr_accessor :rails_type
     attr_accessor :map
+    attr_accessor :java_map
 
     def set_map
       # Only for mysql
@@ -17,6 +18,18 @@ module Liquigen
         binary: 'blob',
         boolean: 'tinyint(1)'
       }
+
+      self.java_map = {
+        integer: 'Long',
+        long: 'Long',
+        string: 'String',
+        text: 'String',
+        float: 'Float',
+        decimal: 'BigDecimal',
+        datetime: 'Date',
+        binary: 'Object',
+        boolean: 'boolean'
+      }
     end
 
     def initialize(type)
@@ -27,5 +40,9 @@ module Liquigen
     def db_type
       map[rails_type.to_sym]
     end
+
+    def java_type
+      java_map[rails_type.to_sym]
+    end
   end
 end

data/lib/liquigen/version.rb

@@ -1,3 +1,3 @@
 module Liquigen
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'.freeze
 end

data/spec/liquigen/change_set_spec.rb

@@ -5,6 +5,6 @@ RSpec.describe Liquigen::ChangeSet, type: :model do
 
   describe '#current git user' do
     let(:author) { 'Jeremy Cui' }
-    specify { expect(change_set.author).to eq author }
+    specify { expect(change_set.author.include?(author)).to be_truthy }
   end
 end

data/spec/liquigen/scaffold/controller_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe Liquigen::Scaffold::Controller, type: :model do
+  let(:name) { 'user' }
+  let(:props) { ['id:integer', 'name:string'] }
+  let(:package) { 'com.hongshu.io.controller' }
+
+  before do
+    Liquigen.java_codes_root = 'src/main/java'
+    allow_any_instance_of(Liquigen::Scaffold::Entity).to receive(:current_package).and_return(package)
+  end
+
+  let(:entity) { described_class.new name, props }
+
+  describe '#filename' do
+    specify { expect(entity.file_name).to eq 'UsersController.java' }
+  end
+end

data/spec/liquigen/scaffold/entity_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe Liquigen::Scaffold::Entity, type: :model do
+  let(:name) { 'user' }
+  let(:props) { ['id:integer', 'name:string'] }
+  let(:package) { 'com.hongshu.io.entity' }
+
+  before do
+    Liquigen.java_codes_root = 'src/main/java'
+    allow_any_instance_of(Liquigen::Scaffold::Entity).to receive(:current_package).and_return(package)
+  end
+
+  let(:entity) { described_class.new name, props }
+
+  describe '#location' do
+    specify { expect(entity.directory).to eq 'src/main/java/com/hongshu/io/entity' }
+  end
+
+  describe '#filename' do
+    specify { expect(entity.file_name).to eq 'User.java' }
+  end
+end

data/spec/liquigen/scaffold/repository_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe Liquigen::Scaffold::Repository, type: :model do
+  let(:name) { 'user' }
+  let(:props) { ['id:integer', 'name:string'] }
+  let(:package) { 'com.hongshu.io.repository' }
+
+  before do
+    Liquigen.java_codes_root = 'src/main/java'
+    allow_any_instance_of(Liquigen::Scaffold::Entity).to receive(:current_package).and_return(package)
+  end
+
+  let(:entity) { described_class.new name, props }
+
+  describe '#filename' do
+    specify { expect(entity.file_name).to eq 'UserRepository.java' }
+  end
+end

data/spec/liquigen_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe Liquigen do
+  describe 'module variable' do
+    let(:package_name) { 'com.liquigen.example' }
+    before { Liquigen.package_name = package_name }
+    specify { expect(Liquigen.package_name).to eq package_name }
+  end
+
+  describe '#load_lines' do
+    let(:lines) do
+      [
+        'package_name=com.hongshu.io',
+        'java_codes_root=src/main/java',
+        ''
+      ]
+    end
+
+    before { Liquigen.load_lines lines }
+    before { Liquigen.load_default }
+    specify { expect(Liquigen.package_name).to eq('com.hongshu.io') }
+    specify { expect(Liquigen.controller_package_name).to eq('com.hongshu.io.controller') }
+    specify { expect(Liquigen.java_codes_root).to eq('src/main/java') }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liquigen
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Jeremy Cui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2018-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,6 +133,11 @@ files:
 - lib/liquigen/modify_data_type.rb
 - lib/liquigen/rename_column.rb
 - lib/liquigen/rename_table.rb
+- lib/liquigen/scaffold/base.rb
+- lib/liquigen/scaffold/config.rb
+- lib/liquigen/scaffold/controller.rb
+- lib/liquigen/scaffold/entity.rb
+- lib/liquigen/scaffold/repository.rb
 - lib/liquigen/sql.rb
 - lib/liquigen/type_map.rb
 - lib/liquigen/version.rb
@@ -147,6 +152,10 @@ files:
 - spec/liquigen/handlers/rename_column_spec.rb
 - spec/liquigen/handlers/rename_table_spec.rb
 - spec/liquigen/handlers/sql_spec.rb
+- spec/liquigen/scaffold/controller_spec.rb
+- spec/liquigen/scaffold/entity_spec.rb
+- spec/liquigen/scaffold/repository_spec.rb
+- spec/liquigen_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/jerecui/liquigen
 licenses: []