templet_rails 0.1.0 → 0.2.0

data/lib/generators/templet/install/USAGE

@@ -0,0 +1,16 @@
+Description:
+    This generator creates a new application area, and is to be run just once.
+    It creates the directory tree, app/helpers/app/,
+    which is where your own (application) code goes underneath.
+    The option --include-core-specs (default: false) adds starter tests that
+    check the HTML in the supplied view layouts.
+
+Example:
+    rails generate templet:install --include-layout-specs
+
+    This will create:
+        app/helpers/app.rb         # For global settings in your own code
+        app/helpers/app/**         # Your own (application) code
+        spec/support/apis/*        # For testing JSON sent from the controller
+        spec/support/templet/*     # For testing the HTML in the rendered views
+        spec/helpers/app/layouts/  # For testing layouts - if requested

data/lib/generators/templet/install/install_generator.rb

@@ -0,0 +1,103 @@
+
+require_relative '../shared/core_helpers'
+
+module Templet
+  class InstallGenerator < Rails::Generators::Base
+    include Shared::CoreHelpers
+
+    CONTROLLER_SUBDIR = 'controllers/'
+    APIS_SUBDIR = 'apis/'
+
+    LAYOUTS = '/layouts'
+
+    source_root File.expand_path('./', __FILE__)
+    desc
+
+    #DEST_DESC = 'The directory that the app code will be copied beneath'
+    #class_option :dest, type: :string, aliases: "-d", default: '', desc: DEST_DESC
+    DESC = "Add specs for the layouts (default: false)"
+    class_option 'include-layout-specs', type: :boolean, default: false, desc: DESC
+
+
+    def ensure_uninstalled
+      if dir = already_installed_at
+        puts "Can't install while there are files present in #{dir}"
+
+        exit
+      end
+    end
+
+    def create_app
+      create_app_tree
+
+      create_app_rb
+
+      mount_engine
+    end
+
+    def create_rspec_support
+      if rspec?
+        %i(shared viewer).each do |subdir|
+          directory spec_support_dir_source(subdir), spec_support_dir_target
+        end
+
+        directory api_support_dir_source, api_support_dir_target
+
+        create_layout_specs if include_layout_specs?
+      end
+    end
+
+    private
+
+    def create_app_tree
+      directory app_dir_source, app_dir_target
+    end
+
+    def create_app_rb
+      copy_helper 'app.rb'
+    end
+
+    def create_layout_specs
+      layouts_source_dir = SOURCE_ROOT + SPEC_SUBDIR + LAYOUTS
+
+      layouts_target_dir = SPEC_SUBDIR + HELPERS_SUBDIR + APP_SUBDIR + LAYOUTS
+
+      directory layouts_source_dir, layouts_target_dir
+    end
+
+    def app_dir_source
+      SOURCE_ROOT + APP_SUBDIR
+    end
+    def app_dir_target
+      APP_ROOT + HELPERS_SUBDIR + APP_SUBDIR
+    end
+
+    def spec_support_dir_source(subdir)
+      SOURCE_ROOT + spec_support_dir + "#{subdir}/"
+    end
+    def spec_support_dir_target
+      spec_support_dir + TEMPLET_SUBDIR
+    end
+
+    def api_support_dir_source
+      SOURCE_ROOT + spec_support_dir + APIS_SUBDIR
+    end
+    def api_support_dir_target
+      spec_support_dir + APIS_SUBDIR
+    end
+
+    def dest_dirs
+      [ APP_ROOT + HELPERS_SUBDIR + APP_SUBDIR ]
+    end
+
+    def include_layout_specs?
+      options['include-layout-specs']
+    end
+
+    def mount_engine
+      mount = "mount TempletRails::Engine, at: '/templet'"
+
+      route mount unless IO.read('config/routes.rb') =~ /#{mount}/m
+    end
+  end
+end

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

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

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

@@ -109,6 +109,7 @@ end
 
     %Q[
 require "rails_helper"
+require 'rack/test/methods'
 #{comment}
 RSpec.describe #{class_name.pluralize}Controller, type: :api do
   it_behaves_like "a json controller"#{action_syms ', '} do

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

@@ -7,69 +7,71 @@ 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 * ' '}" : ''
+module Templet
+  class 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
 end

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

@@ -18,6 +18,10 @@ module Shared
       puts "#{from}\n    => #{to}"
     end
 
+    def copy_helper(file)
+      copy_file helper_dir_source(file), helper_dir_target(file)
+    end
+
     #alias copy_file copy
     #alias directory copy
 
@@ -25,9 +29,15 @@ module Shared
       Dir.exists? spec_support_dir
     end
 
+    def helper_dir_target(file)
+      APP_ROOT + HELPERS_SUBDIR + file
+    end
     def spec_support_dir
       SPEC_SUBDIR + SUPPORT_SUBDIR
     end
+    def helper_dir_source(file)
+      SOURCE_ROOT + HELPERS_SUBDIR + file
+    end
 
     def already_installed_at
       dest_dirs.each do |dir|

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

@@ -24,8 +24,8 @@ module Shared
     def field_with_type(model_name, types)
       names_to_types = model_types(model_fields model_name)
 
-      types.each do |wanted_type|
-        names_to_types.each do |(name, type)|
+      names_to_types.each do |(name, type)|
+        types.each do |wanted_type|
           return name, type if type == wanted_type
         end
       end

data/lib/generators/templet/templates/core/app/base_viewer.rb

@@ -1,7 +1,7 @@
 
 module App
   class BaseViewer < Templet::ViewerRest
-    include Panel::OptionsConfig
+    include Layouts::OptionsConfig
   end
 end
 

data/lib/generators/templet/templates/core/app/{panel → layouts}/layout_base.rb

@@ -1,6 +1,6 @@
 
 module App
-  module Panel
+  module Layouts
     # Renders a navbar, flash messages and yielded content in Bootstrap grid
     class LayoutBase < Templet::Component::Partial
       include Templet::Mixins::Bs::Grid
@@ -28,11 +28,11 @@ module App
       end
 
       def messages
-        FlashMessages.new(renderer).(**bs_column_opts)
+        Panel::FlashMessages.new(renderer).(**bs_column_opts)
       end
 
       def navbar(*args)
-        Nav.new(renderer).(*args)
+        Navbar.new(renderer).(*args)
       end
     end
   end

data/lib/generators/templet/templates/core/app/{panel → layouts}/layout_header.rb

@@ -1,6 +1,6 @@
 
 module App
-  module Panel
+  module Layouts
     # Renders a heading with a title, subtitle and perhaps something on right
     class LayoutHeader < LayoutBase
       def call(action, **options)
@@ -9,6 +9,8 @@ module App
         super { [ header(*args), yield(renderer) ] }
       end
 
+      private
+
       def header(title, subtitle, on_right)
         renderer.call do
           div :page_header do