templet_rails 0.1.0

data/lib/generators/templet/routes/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Displays the routing entry for a REST controller.
+    If the option, --add-route is supplied then it actually writes this
+    routing information to the config/routes.rb file.
+
+Example:
+    rails generate templet:routes admin/user --parent group --add-route --actions index show
+
+    This example will add an entry near the top of:
+        config/routes.rb
+    as follows:
+        namespace('admin') do
+          resources(:groups, only: []) { resources(:users, only: %i(index show)) }
+        end

data/lib/generators/templet/routes/routes_generator.rb

@@ -0,0 +1,64 @@
+
+require_relative '../shared/parent_option'
+require_relative '../shared/add_routes_option'
+require_relative '../shared/actions_option'
+
+class Templet::RoutesGenerator < Rails::Generators::NamedBase
+  include Shared::ParentOption
+  include Shared::AddRoutesOption
+  include Shared::ActionsOption
+
+  source_root File.expand_path('.', __FILE__)
+  desc
+
+  def add_routes
+    routes = route_statement
+
+    if add_routes?
+      route routes
+
+      puts 'Routes written to config/routes.rb as follows:', routes
+    else
+      puts 'If applicable, update your config/routes.rb file with:', routes
+    end
+  end
+
+  private
+
+  def route_statement
+    in_scope { in_parent { resources plural_name, only_actions: true } }
+  end
+
+  def in_scope
+    if scope_name
+      "  namespace('#{scope_name}') do\n  #{yield}\n  end\n"
+    else
+      yield
+    end
+  end
+
+  def in_parent
+    if parent
+      "  #{resources parent.pluralize, no_only: true} { #{yield} }"
+    else
+      "  #{yield}"
+    end
+  end
+
+  def resources(name, **options)
+    "resources(:#{name}#{only_actions **options})"
+  end
+
+  ONLY = ', only: '
+  def only_actions(only_actions: false, no_only: false)
+    only_actions ? action_syms(ONLY) : no_only ? "#{ONLY}[]" : ''
+  end
+
+  def scope_name
+    elements = file_path.split('/')[0..-2]
+
+    if elements.any?
+      elements * '/'
+    end
+  end
+end

data/lib/generators/templet/rspec/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Creates tests to check the HTML in the views using CSS selectors.
+    And further tests to check the JSON output from the controller.
+
+Example:
+    rails generate templet:rspec admin/user --model person --parent group --grand-parent sector
+
+    This will create:
+        spec/apis/admin/users_controller_spec.rb
+        spec/helpers/app/admin/user_viewer_spec.rb

data/lib/generators/templet/rspec/rspec_generator.rb

@@ -0,0 +1,124 @@
+
+require_relative '../shared/parent_option'
+require_relative '../shared/grand_parent_option'
+require_relative '../shared/model_option'
+require_relative '../shared/comment_tests_option'
+require_relative '../shared/model_fields'
+require_relative '../shared/actions_option'
+
+class Templet::RspecGenerator < Rails::Generators::NamedBase
+  FILL_IN = 'FILL_IN_FIELD_NAME'
+
+  include Shared::ParentOption
+  include Shared::GrandParentOption
+  include Shared::ModelOption
+  include Shared::CommentTestsOption
+  include Shared::ActionsOption
+
+  include Shared::ModelFields
+
+  viewer_desc = "Create a spec file containing tests for the viewer class"
+  class_option 'viewer-tests', type: :boolean, aliases: "-v",
+                               default: true, desc: viewer_desc
+
+  source_root File.expand_path('.', __FILE__)
+  desc
+
+  def create_viewer
+    create_file viewer_path, viewer_spec if viewer_tests?
+  end
+
+  def create_controller_api
+    create_file controller_api_path, controller_api_spec
+  end
+
+  private
+
+  def viewer_path
+    "spec/helpers/app/#{file_path}_viewer_spec.rb"
+  end
+
+  def viewer_tests?
+    options['viewer-tests']
+  end
+
+  def controller_api_path
+    "spec/apis/#{file_path.pluralize}_controller_spec.rb"
+  end
+
+  def assign_overrides
+    "#{assign_parent}#{assign_grand_parent}#{assign_scope}#{assign_controller}"
+  end
+
+  def assign_parent
+    parent ? "    let(:parent_name) { :#{parent} }\n\n" : ""
+  end
+
+  def assign_grand_parent
+    grand_parent ? "    let(:grand_parent_name) { :#{grand_parent} }\n\n" : ""
+  end
+
+  def assign_scope
+    elements = file_path.split('/')[0..-2]
+
+    if elements.any?
+      scope = elements * '/'
+
+      scope ? "    let(:scope) { '#{scope}' }\n\n" : ""
+    end
+  end
+
+  def assign_controller
+    controller_name = file_path.split('/').last
+
+    if controller_name != model_name
+      "    let(:controller_name) { '#{controller_name.pluralize}' }\n\n"
+    end
+  end
+
+  def comment(name=:begin)
+    comment_tests? ? "\n=#{name}" : ''
+  end
+
+  def viewer_spec
+    name = model_name || singular_name
+
+    input_field, input_field_tag = textual_field_with_tag name
+
+    %Q[
+require "rails_helper"
+#{comment}
+RSpec.describe App::#{class_name}Viewer, type: :helper do
+  it_should_behave_like "a viewer"#{action_syms ', '} do
+    let(:model_name) { :#{name} }
+
+#{assign_overrides}
+    let(:field_name) { :#{input_field || FILL_IN} }
+
+    let(:input_field_tag) { "#{input_field_tag || FILL_IN}" }
+  end
+end
+#{comment :end}
+]
+  end
+
+  def controller_api_spec
+    name = model_name || singular_name
+
+    input_field, _ = textual_field_with_tag name
+
+    %Q[
+require "rails_helper"
+#{comment}
+RSpec.describe #{class_name.pluralize}Controller, type: :api do
+  it_behaves_like "a json controller"#{action_syms ', '} do
+    let(:model_singular) { :#{name} }
+
+#{assign_overrides}
+    let(:field_name) { :#{input_field || FILL_IN} }
+  end
+end
+#{comment :end}
+]
+  end
+end

data/lib/generators/templet/scaffold/USAGE

@@ -0,0 +1,22 @@
+Description:
+    Generates a CRUD controller that renders a view via a Viewer class,
+    an actual Viewer class (which renders HTML),
+    tests for the controller & views,
+    and a routing entry for config/routes.rb.
+    It should produce fully working code.
+    It invokes, in turn, the four generators:
+      templet:controller, templet:viewer, templet:rspec and templet:routes.
+    By default, the model's name is taken from that of the controller's,
+    to specify a different model name use the MODEL option
+
+Example:
+   rails generate templet:scaffold admin/user --model person --parent group --grand-parent department --child project --add-routes --actions index show
+
+    This will create:
+        app/controllers/admin/users_controller.rb
+        app/helpers/app/admin/user_viewer.rb
+        spec/apis/admin/users_controller_spec.rb
+        spec/helpers/app/admin/user_viewer_spec.rb
+
+    And, if requested, will add an entry to:
+        config/routes.rb

data/lib/generators/templet/scaffold/scaffold_generator.rb

@@ -0,0 +1,75 @@
+
+require_relative '../shared/model_option'
+require_relative '../shared/parent_option'
+require_relative '../shared/grand_parent_option'
+require_relative '../shared/child_option'
+require_relative '../shared/add_routes_option'
+require_relative '../shared/comment_tests_option'
+require_relative '../shared/actions_option'
+
+class Templet::ScaffoldGenerator < Rails::Generators::NamedBase
+  include Shared::ModelOption
+  include Shared::ParentOption
+  include Shared::GrandParentOption
+  include Shared::ChildOption
+  include Shared::CommentTestsOption
+  include Shared::AddRoutesOption
+  include Shared::ActionsOption
+
+  source_root File.expand_path('.', __FILE__)
+  desc
+
+  def create_controller
+    generate 'templet:controller', args(name, parent_option, model_option,
+                                        grand_parent_option, actions_option)
+  end
+
+  def create_viewer_subclass
+    generate 'templet:viewer', args(name, child_option, actions_option)
+  end
+
+  def create_rspec
+    generate 'templet:rspec', args(name, parent_option, model_option,
+                                   grand_parent_option,
+                                   comment_tests_option, actions_option)
+  end
+
+  def create_routes
+    generate 'templet:routes', args(name, parent_option,
+                                    add_routes_option, actions_option)
+  end
+
+  private
+
+  def args(*options)
+    options * ' ' + ' '
+  end
+
+  def parent_option
+    parent ? "--parent #{parent}" : ''
+  end
+
+  def model_option
+    model_name? ? "--model #{model_name}" : ''
+  end
+
+  def grand_parent_option
+    grand_parent ? "--grand-parent #{grand_parent}" : ''
+  end
+
+  def child_option
+    child? ? "--child #{child}" : ''
+  end
+
+  def add_routes_option
+    add_routes? ? "--add-routes" : ''
+  end
+
+  def comment_tests_option
+    comment_tests? ? '' : "--no-comment-tests"
+  end
+
+  def actions_option
+    actions&.any? ? "--actions #{actions * ' '}" : ''
+  end
+end

data/lib/generators/templet/shared/actions_option.rb

@@ -0,0 +1,24 @@
+
+module Shared
+  module ActionsOption
+    def self.included(base)
+      desc = "A list of REST action names - leave this out if you want them all"
+
+      base.class_eval do
+        class_option :actions, type: :array, aliases: "-a",
+                               banner: 'index show create',
+                               default: [], desc: desc
+      end
+    end
+
+    private
+
+    def actions
+      options['actions'].any? ? options['actions'] : nil
+    end
+
+    def action_syms(prefix='')
+      actions and "#{prefix}%i(#{actions * ' '})"
+    end
+  end
+end

data/lib/generators/templet/shared/add_routes_option.rb

@@ -0,0 +1,19 @@
+
+module Shared
+  module AddRoutesOption
+    def self.included(base)
+      desc = "Update the the file config/routes.rb"
+
+      base.class_eval do
+        class_option 'add-routes', type: :boolean, aliases: "-r",
+                                   default: false, desc: desc
+      end
+    end
+
+    private
+
+    def add_routes?
+      options['add-routes']
+    end
+  end
+end

data/lib/generators/templet/shared/child_option.rb

@@ -0,0 +1,23 @@
+
+module Shared
+  module ChildOption
+    def self.included(base)
+      desc = "A direct descendant of the model - the principal has_many record type"
+
+      base.class_eval do
+        class_option :child, type: :string, aliases: "-c", default: nil,
+                             banner: 'singular name', desc: desc
+      end
+    end
+
+    private
+
+    def child
+      options['child']
+    end
+
+    def child?
+      child and child.present?
+    end
+  end
+end

data/lib/generators/templet/shared/comment_tests_option.rb

@@ -0,0 +1,19 @@
+
+module Shared
+  module CommentTestsOption
+    def self.included(base)
+      desc = "Insert block comments around Viewer and JSON tests"
+
+      base.class_eval do
+        class_option 'comment-tests', type: :boolean, aliases: "-t",
+                                      default: true, desc: desc
+      end
+    end
+
+    private
+
+    def comment_tests?
+      options['comment-tests']
+    end
+  end
+end

data/lib/generators/templet/shared/core_helpers.rb

@@ -0,0 +1,48 @@
+
+module Shared
+  module CoreHelpers
+    SOURCE_ROOT = File.expand_path('../../templates/core', __FILE__) + '/'
+
+    LIB_ROOT = 'lib/'
+    APP_ROOT = 'app/'
+
+    APP_SUBDIR = 'app/'
+    HELPERS_SUBDIR = 'helpers/'
+    TEMPLET_SUBDIR = 'templet/'
+    SPEC_SUBDIR = 'spec/'
+    SUPPORT_SUBDIR = 'support/'
+
+    private
+
+    def copy(from, to)
+      puts "#{from}\n    => #{to}"
+    end
+
+    #alias copy_file copy
+    #alias directory copy
+
+    def rspec?
+      Dir.exists? spec_support_dir
+    end
+
+    def spec_support_dir
+      SPEC_SUBDIR + SUPPORT_SUBDIR
+    end
+
+    def already_installed_at
+      dest_dirs.each do |dir|
+        return dir if Dir.exists?(dir) and not Dir.empty?(dir)
+      end
+
+      nil
+    end
+
+    def dest_dirs
+      [ core_default_dir ]
+    end
+
+    def core_default_dir
+      APP_ROOT + HELPERS_SUBDIR + TEMPLET_SUBDIR
+    end
+  end
+end