nested-generators 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 473261670f239df50312ba210ded00cb31d0744d59a373293c00d4fd9423ce80
+  data.tar.gz: a43a7325760333d9af3d4e642b2e1b03084ab6973e38f633481450cb7d3816d2
+SHA512:
+  metadata.gz: cdb84c48b0c89bae2d1fa863d1cdaa123d9f4b4a628ab70dd9f9e7ec97ba909f0805ef007dcd40218142fa6161bbe2bb086376935d9709abccceecf6cf5a35e4
+  data.tar.gz: d748483ce4b8abf771cdcc001be5c364b89fcb13dbad7b50ec755be3690d3f1ba4b370fafc68fb21b4a659314c6c8632f03e37c269a6224e219011dc2b146b80

data/lib/generators/nested_generators_base_generator.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+class NestedGeneratorsBaseGenerator < Rails::Generators::NamedBase
+  SCOPES = %w[public protected private].freeze
+  RETURN = '
+'
+  argument :methods, type: :array,
+                     default: [],
+                     banner: 'public:method "protected:method?" "private:method!"'
+
+  private
+
+  def create_base
+    return if base?
+
+    template 'base_class_template.erb', base_file_path
+  end
+
+  def create_class_file
+    template 'class_template.erb', class_file_path
+  end
+
+  def create_class_spec_file
+    template 'class_spec_template.erb', class_spec_file_path
+  end
+
+  def base?
+    File.exist?(base_file_path)
+  end
+
+  def base_file_path
+    @base_file_path ||= "app/#{@type.pluralize}/application_#{@type}.rb"
+  end
+
+  def class_file_path
+    "#{(%w[app] + modules.map(&:underscore)).join('/')}/#{class_file_name}.rb"
+  end
+
+  def class_spec_file_path
+    "#{(%w[spec] + modules.map(&:underscore)).join('/')}/#{class_file_name}_spec.rb"
+  end
+
+  def class_file_name
+    @class_file_name ||= "#{last_part.underscore}_#{@type}"
+  end
+
+  def last_part
+    @last_part ||= class_name.split('::')[-1]
+  end
+
+  def modules
+    @modules ||= [@type.pluralize.capitalize] + class_name.split('::')[0..-2]
+  end
+
+  def open_modules_nesting
+    modules.each.with_index.map { |namespace, index| "#{indent * index}module #{namespace}" }.join(RETURN)
+  end
+
+  def close_modules_nesting
+    modules.each.with_index.map { |_namespace, index| "#{indent * index}end" }.reverse.join(RETURN)
+  end
+
+  def open_class
+    "#{RETURN}#{class_indent}class #{last_part}#{@type.capitalize}" + (base? ? " < Application#{@type.capitalize}" : '')
+  end
+
+  def end_class
+    "#{class_indent}end#{RETURN}"
+  end
+
+  def class_indent
+    @class_indent ||= indent * modules.length
+  end
+
+  def code_indent
+    @code_indent ||= indent * (modules.length + 1)
+  end
+
+  def indent
+    @indent ||= '  '
+  end
+
+  def in_scope?(method, name)
+    " #{method.split(':')&.[](0)} " == " #{name} "
+  end
+
+  def scope?(name)
+    methods&.any? { |method| in_scope?(method, name) }
+  end
+
+  def scope_methods(name)
+    methods&.select { |method| in_scope?(method, name) }&.map(&:strip)
+  end
+
+  def strip_scope(method, name)
+    method.gsub("#{name}:", '')
+  end
+
+  def rspec_empty_message(method = nil)
+    "pending 'add some examples to (or delete) #{class_spec_file_path}#{method.nil? ? '' : ('#' + method)}'"
+  end
+end

data/lib/generators/query/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Generates QueryObject and its corresponding RSpec test file. Accepts
+    scoped methods as arguments.
+
+Usage:
+    Pass the name of the QueryObject, either CamelCased or under_scored, as
+    the first argument along with an optional list of its scoped method names.
+
+    For further instructions refer to the documentation at
+    https://github.com/wscourge/nested-generators#queryobject-generator
+
+Examples:
+    rails generate query tomatoes
+
+        In the app/queries directory it creates a QueryObject called
+        "TomatoesQuery" along with corresponding RSpec test file in the
+        spec/queries directory.
+
+    rails generate query vegetables/potatoes
+
+        In the app/queries/vegetables directory it creates a QueryObject
+        called "Vegetables::PotatoesQuery" along with corresponding RSpec test
+        file in the spec/queries/vegetables.
+
+    rails generate query fruits public:fresh "protected:skip!" "private:fresh?"
+
+        Creates QueryObject called "FruitsQuery" with three methods: public
+        "fresh", protected "skip!" and private "fresh?". Quote method names with
+        special characters.

data/lib/generators/query/query_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'generators/nested_generators_base_generator'
+
+class QueryGenerator < NestedGeneratorsBaseGenerator
+  source_root File.expand_path('templates', __dir__)
+
+  def initialize(*args, &block)
+    super
+    @type = 'query'
+  end
+
+  def create_query_file
+    create_class_file
+    create_class_spec_file
+  end
+end

data/lib/generators/query/templates/class_spec_template.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec.describe <%= @type.capitalize.pluralize %>::<%= class_name %><%= @type.capitalize %> do
+  <%- if scope?('public') -%>
+    <%- scope_methods('public').each do |method| -%>
+  describe '#<%= strip_scope(method, 'public') %>' do
+    <%= rspec_empty_message(strip_scope(method, 'public')) %>
+  end
+    
+    <%- end -%>
+  <%- else -%>
+  <%= rspec_empty_message %>
+  <%- end -%>
+end

data/lib/generators/query/templates/class_template.erb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+<%= open_modules_nesting %><%= open_class %>
+<%= code_indent %>def initialize(relation)
+<%= code_indent %>  @relation = relation
+<%= code_indent %>end
+<%- SCOPES.each.with_index do |name, index| -%>
+  <%- if index.zero? -%>
+    <%- if scope?(name) -%>
+      <%- scope_methods(name).each do |method| %>
+<%= code_indent %>def <%= method.gsub("#{name}:", '') %>
+<%= code_indent %>end
+      <%- end -%>
+    <%- end -%>
+  <%- else -%>
+    <%- if scope?(name) -%><%- %>
+<%- %><%= code_indent %><%= name %>
+      <%- scope_methods(name).each do |method| %>
+<%= code_indent %>def <%= method.gsub("#{name}:", '') %>
+<%= code_indent %>end
+      <%- end -%>
+    <%- end -%>
+  <%- end -%>
+<%- end -%>
+<%= end_class %><%= close_modules_nesting %>

data/lib/generators/service/USAGE

@@ -0,0 +1,34 @@
+Description:
+    Generates ServiceObject and its corresponding RSpec test file. Accepts
+    scoped methods as arguments.
+
+    IMPORTANT: On the first run, it also generates ApplicationService class
+    file from which all further generated ServiceObjects inherit.
+
+Usage:
+    Pass the name of the ServiceObject, either CamelCased or under_scored, as
+    the first argument along with an optional list of its scoped method names.
+
+    For further instructions refer to the documentation at
+    https://github.com/wscourge/nested-generators#serviceobject-generator
+
+Examples:
+    rails generate service cucumber
+
+        In the app/services directory it creates a ServiceObject called
+        "CucumberService" containing single public "call" method and the
+        "ApplicationService" along with corresponding RSpec test file in the
+        spec/services directory.
+
+    rails generate service vegetables/tomato
+
+        In the app/services/vegetables directory it creates a ServiceObject
+        called "Vegetables::TomatoService" containing single public "call"
+        method along with corresponding RSpec test file in the
+        spec/services/vegetables.
+
+    rails generate service swat public:nuke "protected:arm!" "private:ready?"
+
+        Creates ServiceObject called "SwatService" with four methods: public
+        "call", public "nuke", protected "arm!" and private "ready?". Quote
+        method names with special characters.

data/lib/generators/service/service_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'generators/nested_generators_base_generator'
+
+class ServiceGenerator < NestedGeneratorsBaseGenerator
+  source_root File.expand_path('templates', __dir__)
+
+  def initialize(*args, &block)
+    super
+    @type = 'service'
+  end
+
+  def create_service_file
+    create_base
+    create_class_file
+    create_class_spec_file
+  end
+end

data/lib/generators/service/templates/base_class_template.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module <%= @type.pluralize.capitalize%>
+  class Application<%= @type.capitalize%>
+    def self.call(*args)
+      new(*args).call
+    end
+  end
+end

data/lib/generators/service/templates/class_spec_template.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec.describe <%= @type.capitalize.pluralize %>::<%= class_name %><%= @type.capitalize %> do
+  describe '#call' do
+    <%= rspec_empty_message('call') %>
+  end
+  <%- if scope?('public') -%>
+    <%- scope_methods('public').each do |method| %>
+  describe '#<%= strip_scope(method, 'public') %>' do
+    <%= rspec_empty_message(strip_scope(method, 'public')) %>
+  end
+    <%- end -%>
+  <%- end -%>
+end

data/lib/generators/service/templates/class_template.erb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+<%= open_modules_nesting %><%= open_class %>
+<%= code_indent %>def initialize
+<%= code_indent %>end
+
+<%= code_indent %>def call
+<%= code_indent %>end
+<%- SCOPES.each.with_index do |name, index| -%>
+  <%- if index.zero? -%>
+    <%- if scope?(name) -%>
+      <%- scope_methods(name).each do |method| %>
+<%= code_indent %>def <%= method.gsub("#{name}:", '') %>
+<%= code_indent %>end
+      <%- end -%>
+    <%- end -%>
+  <%- else -%>
+    <%- if scope?(name) -%><%- %>
+<%- %><%= code_indent %><%= name %>
+      <%- scope_methods(name).each do |method| %>
+<%= code_indent %>def <%= method.gsub("#{name}:", '') %>
+<%= code_indent %>end
+      <%- end -%>
+    <%- end -%>
+  <%- end -%>
+<%- end -%>
+<%= end_class %><%= close_modules_nesting %>

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: nested-generators
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- wscourge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+description: A handful of rails generate scripts
+email:
+- wscourge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/nested_generators_base_generator.rb
+- lib/generators/query/USAGE
+- lib/generators/query/query_generator.rb
+- lib/generators/query/templates/class_spec_template.erb
+- lib/generators/query/templates/class_template.erb
+- lib/generators/service/USAGE
+- lib/generators/service/service_generator.rb
+- lib/generators/service/templates/base_class_template.erb
+- lib/generators/service/templates/class_spec_template.erb
+- lib/generators/service/templates/class_template.erb
+homepage: https://github.com/wscourge/nested-generators
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thanks for installing! See rails generate service --help for
+  usage
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Nested generators
+test_files: []