trailblazer_scaffold 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9b3fd37ecc1e8eeb68b4739716f63921e6ba7c138dbf4761214b8da594f86ac
+  data.tar.gz: d45796dd7ff26ef025fe3380ed88c13c9f31c8b0b9f4ff7df517afdb6154b0b6
+SHA512:
+  metadata.gz: df7e15c9cc15835f9186f64044ea3eff4c55eaf3b395d25dfb621d6d5f01877d909c34071058fb74578fe2654946e51c81b91e1235c966ce3d2e57880c4781a5
+  data.tar.gz: 7345c2e5300e7549ce01b154636383c8b6363b4dac9575ee4ab33d4ea25d94a35c6ac9fcc6adbd2591f567554a82add3a761f23939a78d1b6c7e7e686646a5c1

data/lib/generators/trailblazer_scaffold/generate_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+module TrailblazerScaffold
+  class GenerateGenerator < Rails::Generators::Base
+
+    model_name = ARGV[0]
+    actions = TrailblazerScaffold::Generate.new.call(model_name)
+    result_text = if actions.present?
+     "operations and contract for #{actions.join(', ')} has been generated"
+    else
+     'there was no action for model to create the contract and operaitons for'
+                  end
+    p result_text
+  end
+end

data/lib/trailblazer_scaffold/contract/generate.rb

@@ -0,0 +1,57 @@
+module TrailblazerScaffold::Contract
+  class Generate
+
+    BLACKLIST_COLUMNS = %w(id created_at updated_at)
+
+    PROPERTY_TYPES = %i(integer float boolean)
+
+    def call(model)
+      model_path = model.to_s.downcase.split('::').join('/')
+      dir_path = Rails.root.join('app/concepts', model_path, 'contract')
+      FileUtils.mkdir_p(dir_path) unless File.directory?(dir_path)
+      file_name = 'base.rb'
+      File.write((dir_path + file_name), generate_class_text(model))
+    end
+
+    def generate_class_text(model)
+      klass_text = "class #{model}\n  class Contract::Base < Reform::Form\n"
+      properties = get_properties(model)
+      properties.each do |property|
+        klass_text += "    property :#{property[:name]}#{validation(property)}\n"
+      end
+      klass_text +=  "  end\nend\n"
+    end
+
+    def get_properties(model)
+      model.columns.map do |column|
+        next if BLACKLIST_COLUMNS.include? column.name
+        { name: column.name, allow_null: column.default || column.null, type: column.type }
+      end.compact
+    end
+
+    def validation(property)
+      presence_validation = validate_presence(property[:allow_null])
+      type_validation = validation_type(property[:type])
+      return unless presence_validation || type_validation
+      ", validates: {#{[presence_validation, type_validation].compact.join(',')} }"
+    end
+
+    def validation_type(type)
+      return  unless PROPERTY_TYPES.include?(type)
+      case type
+      when :integer
+        ' numericality: { only_integer: true }'
+      when :float
+        ' numericality: { only_float: true }'
+      when :boolean
+        ' inclusion: { in: [true, false] }'
+      end
+    end
+
+    def validate_presence(allow_null)
+      return if allow_null
+      ' presence: true'
+    end
+  end
+
+end

data/lib/trailblazer_scaffold/get_actions.rb

@@ -0,0 +1,15 @@
+require 'active_support/core_ext/string'
+module TrailblazerScaffold
+  class GetActions
+
+    ALLOWED_ACTIONS = %w(create update destroy).freeze
+
+    def call(model_name)
+      klass = (model_name.pluralize + '_controller').classify.safe_constantize
+      klass = (model_name + 'Controller').safe_constantize unless klass.is_a?(Class)
+      return unless klass.is_a?(Class)
+
+      klass.action_methods.select { |action| ALLOWED_ACTIONS.include?(action) }
+    end
+  end
+end

data/lib/trailblazer_scaffold/operation/generate.rb

@@ -0,0 +1,61 @@
+module TrailblazerScaffold::Operation
+  class Generate
+
+    def call(model, actions)
+      model_path = model.to_s.downcase.split('::').join('/')
+      dir_path = Rails.root.join('app/concepts', model_path, 'operation')
+      FileUtils.mkdir_p(dir_path) unless File.directory?(dir_path)
+      actions.each do |action|
+        send("generate_#{action}_operaton_class", model, dir_path)
+      end
+    end
+
+    def generate_create_operaton_class(model, dir_path)
+      class_text = <<~EOF
+        module #{model}
+          class Operaton::Create < Trailblazer::Operation
+            step Model(#{model}, :new)
+            step self::Contract::Build(constant: #{model}::Contract::Base)
+            step self::Contract::Validate()
+            step self::Contract::Persist()
+          end
+        end
+      EOF
+
+      File.write((dir_path + 'create.rb'), class_text)
+    end
+
+    def generate_update_operaton_class(model, dir_path)
+      class_text = <<~EOF
+        module #{model}
+          class Operaton::Update < Trailblazer::Operation
+            step Model(#{model}, :find)
+            step self::Contract::Build(constant: #{model}::Contract::Base)
+            step self::Contract::Validate()
+            step self::Contract::Persist()
+          end
+        end
+      EOF
+
+      File.write((dir_path + 'update.rb'), class_text)
+    end
+
+    def generate_destroy_operaton_class(model, dir_path)
+      class_text = <<~EOF
+        module #{model}
+          class Operaton::Destroy < Trailblazer::Operation
+            step Model(#{model}, :find)
+            step :destroy
+
+            def destroy(_options, model:, **)
+              model.destroy
+            end
+          end
+        end
+      EOF
+
+      File.write((dir_path + 'destroy.rb'), class_text)
+    end
+
+  end
+end

data/lib/trailblazer_scaffold.rb

@@ -0,0 +1,18 @@
+require 'trailblazer_scaffold/get_actions.rb'
+require 'trailblazer_scaffold/contract/generate.rb'
+require 'trailblazer_scaffold/operation/generate.rb'
+module TrailblazerScaffold
+  class Generate
+
+    def call(model_name)
+      unless (model = model_name.safe_constantize) && model.ancestors.include?(ActiveRecord::Base)
+        return puts 'model does not exists'
+      end
+      actions = GetActions.new.call(model_name)
+      TrailblazerScaffold::Contract::Generate.new.call(model)
+      return unless actions.present?
+      TrailblazerScaffold::Operation::Generate.new.call(model, actions)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: trailblazer_scaffold
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mehrnoush Akbari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trailblazer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.7
+- !ruby/object:Gem::Dependency
+  name: trailblazer-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.7
+description: 'To create file run `rails g trailblazer_scaffold:generate ClassName`,
+  if you have nested class just type the whole path for example for shop/product.rb
+  `rails g trailblazer_scaffold:generate Shop::Product` '
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/trailblazer_scaffold/generate_generator.rb
+- lib/trailblazer_scaffold.rb
+- lib/trailblazer_scaffold/contract/generate.rb
+- lib/trailblazer_scaffold/get_actions.rb
+- lib/trailblazer_scaffold/operation/generate.rb
+homepage: https://gitlab.com/mehrnoush10352/trailblazer_scaffold
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://gitlab.com/mehrnoush10352/trailblazer_scaffold
+  homepage_uri: https://gitlab.com/mehrnoush10352/trailblazer_scaffold
+  source_code_uri: https://gitlab.com/mehrnoush10352/trailblazer_scaffold
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: generate operations and contracts based on model and actions
+test_files: []