templet_rails 0.1.0 → 0.2.0

data/lib/generators/templet/controller/controller_generator.rb

@@ -5,102 +5,104 @@ require_relative '../shared/model_option'
 require_relative '../shared/actions_option'
 require_relative '../shared/model_fields'
 
-class Templet::ControllerGenerator < Rails::Generators::NamedBase
-  include Shared::ModelOption
-  include Shared::ParentOption
-  include Shared::GrandParentOption
-  include Shared::ActionsOption
+module Templet
+  class ControllerGenerator < Rails::Generators::NamedBase
+    include Shared::ModelOption
+    include Shared::ParentOption
+    include Shared::GrandParentOption
+    include Shared::ActionsOption
 
-  include Shared::ModelFields
+    include Shared::ModelFields
 
-  TEMPLATE_FILE = 'controller.rb.erb'
+    TEMPLATE_FILE = 'controller.rb.erb'
 
-  SET_MODEL_ACTIONS = %w(show edit update destroy)
+    SET_MODEL_ACTIONS = %w(show edit update destroy)
 
-  source_root File.expand_path('.', __FILE__)
-  desc
+    source_root File.expand_path('.', __FILE__)
+    desc
 
-  source_root File.expand_path('../../templates', __FILE__)
+    source_root File.expand_path('../../templates', __FILE__)
 
-  def create_controller
-    template TEMPLATE_FILE, controller_path
-  end
+    def create_controller
+      template TEMPLATE_FILE, controller_path
+    end
 
-  private
+    private
 
-  def include_action?(action)
-    if actions
-      actions.include? action.to_s
-    else
-      true
+    def include_action?(action)
+      if actions
+        actions.include? action.to_s
+      else
+        true
+      end
     end
-  end
 
-  def before_action(name, only=nil, prefix: "\n  ")
-    return unless name
+    def before_action(name, only=nil, prefix: "\n  ")
+      return unless name
 
-    suffix = only&.any? ? ', only: %i(' + only * ' ' + ')' : ''
+      suffix = only&.any? ? ', only: %i(' + only * ' ' + ')' : ''
 
-    "#{prefix}before_action :set_#{name}#{suffix}\n"
-  end
+      "#{prefix}before_action :set_#{name}#{suffix}\n"
+    end
 
-  def set_model?
-    not actions or set_model_actions.any?
-  end
+    def set_model?
+      not actions or set_model_actions.any?
+    end
 
-  def set_model_actions
-    actions ? SET_MODEL_ACTIONS & actions : SET_MODEL_ACTIONS
-  end
+    def set_model_actions
+      actions ? SET_MODEL_ACTIONS & actions : SET_MODEL_ACTIONS
+    end
 
-  def controller_path
-    File.join("app/controllers", "#{file_path.pluralize}_controller.rb")
-  end
+    def controller_path
+      File.join("app/controllers", "#{file_path.pluralize}_controller.rb")
+    end
 
-  def model_plural
-    model_name.pluralize
-  end
+    def model_plural
+      model_name.pluralize
+    end
 
-  def model_class_name
-    model_name.classify
-  end
+    def model_class_name
+      model_name.classify
+    end
 
-  def receiver
-    parent ? "@#{parent}.#{model_plural}" : model_class_name
-  end
+    def receiver
+      parent ? "@#{parent}.#{model_plural}" : model_class_name
+    end
 
-  def redirect_path(use_instance=true)
-    if parent
-      params = ", id: @#{model_name}" if model_name? and use_instance
+    def redirect_path(use_instance=true)
+      if parent
+        params = ", id: @#{model_name}" if model_name? and use_instance
 
-      "[#{path_scope}@#{parent}, #{path_element use_instance}#{params}]"
-    else
-      "[#{path_scope}#{path_element false}]"
+        "[#{path_scope}@#{parent}, #{path_element use_instance}#{params}]"
+      else
+        "[#{path_scope}#{path_element false}]"
+      end
     end
-  end
 
-  def path_scope
-    elements = file_path.split('/')[0..-2]
+    def path_scope
+      elements = file_path.split('/')[0..-2]
 
-    if elements.any? 
-      (elements.size == 1 ? ":#{elements.first}" : "'/#{elements * "/"}'") + ', '
+      if elements.any? 
+        (elements.size == 1 ? ":#{elements.first}" : "'/#{elements * "/"}'") + ', '
+      end
     end
-  end
 
-  def path_element(use_instance)
-    if use_instance
-      (model_name? ? ':' : '@') + singular_name
-    else
-      ":#{plural_name}"
+    def path_element(use_instance)
+      if use_instance
+        (model_name? ? ':' : '@') + singular_name
+      else
+        ":#{plural_name}"
+      end
     end
-  end
 
-  def path_controller(prefix=nil)
-    parents = [ parent.pluralize, '1' ] if parent
+    def path_controller(prefix=nil)
+      parents = [ parent.pluralize, '1' ] if parent
 
-    [ *file_path.split('/')[0..-2], *parents, plural_name, *prefix ] * '/'
-  end
+      [ *file_path.split('/')[0..-2], *parents, plural_name, *prefix ] * '/'
+    end
 
-  def to_option(key, name, prefix='')
-    name ? "#{prefix}#{key}: :#{name}" : ''
+    def to_option(key, name, prefix='')
+      name ? "#{prefix}#{key}: :#{name}" : ''
+    end
   end
 end

data/lib/generators/templet/core_install/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Installs the complete framework source under new directory trees,
+    by default, the core code is copied under app/helpers/templet/,
+    but you can change this with the option, DEST.
+    If you install under a directory, like lib/ or vendor/, then you must
+    uncomment the 'require' statements in the file, templet/require_all.rb.
+
+Example:
+    rails generate templet:core_insall --dest lib/
+
+    This will create:
+        app/controllers/templet/*  # Helper modules for invoking the framework
+        app/helpers/templet/**     # If dest is given, it replaces 'app/helpers'
+        app/helpers/templet_helper.rb  # For framework settings

data/lib/generators/templet/core_install/core_install_generator.rb

@@ -0,0 +1,77 @@
+
+require_relative '../shared/core_helpers'
+
+module Templet
+  class CoreInstallGenerator < Rails::Generators::Base
+    include Shared::CoreHelpers
+
+    CONTROLLER_SUBDIR = 'controllers/'
+    APIS_SUBDIR = 'apis/'
+
+    source_root File.expand_path('./', __FILE__)
+    desc
+
+    DEST_DESC = 'The directory that the core code will be copied beneath'
+    class_option :dest, type: :string, aliases: "-d", default: '', desc: DEST_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_templet_core
+      create_templet_tree
+
+      create_controller_modules
+
+      create_templet_helper_rb
+    end
+
+    private
+
+    def create_templet_tree
+      directory core_dir_source, core_dir_target
+    end
+
+    def create_controller_modules
+      directory controller_dir_source, controller_dir_target
+    end
+
+    def create_templet_helper_rb
+      copy_helper 'templet_helper.rb'
+    end
+
+    def core_dir_source
+      SOURCE_ROOT + TEMPLET_SUBDIR
+    end
+    def core_dir_target
+      core_dest_subdir + TEMPLET_SUBDIR
+    end
+
+    def controller_dir_source
+      SOURCE_ROOT + CONTROLLER_SUBDIR
+    end
+    def controller_dir_target
+      APP_ROOT + CONTROLLER_SUBDIR + TEMPLET_SUBDIR
+    end
+
+    def dest_dirs
+      super + [ LIB_ROOT + TEMPLET_SUBDIR, core_dest_subdir + TEMPLET_SUBDIR ]
+    end
+
+    def core_dest_subdir
+      if ( dest = options['dest'] ).present?
+        if Dir.exists? dest
+          dest + (dest.end_with?('/') ? '' : '/')
+        else
+          raise "Destination directory, #{dest}, must exist"
+        end
+      else
+        APP_ROOT + HELPERS_SUBDIR
+      end
+    end
+  end
+end

data/lib/generators/templet/core_rspec/USAGE

@@ -1,16 +1,13 @@
 Description:
-    Generates Rspec tests for two sections of the core code.
-    First, tests to check the HTML in the view layouts.
-    Second, an optional step that adds various tests for the framework itself.
-    This second step is superfluous unless you're going to change the source
+    Generates Rspec tests for the core code.
+    It is superfluous unless you're going to change the source
     code - as these tests offer few, if any, real safeguards.
-    Note that the framework tests (second step) will only be installed if
-    the option, --include-core-specs is given, and also if the core is kept
+    Note that the tests will only be installed if the core is kept
     in its default directory, i.e. under app/helpers/templet/.
 
 Example:
     rails generate template:core_rspec --include-core-specs
 
     This will create files under the directories:
-        spec/helpers/app/panel/  # For testing layouts
-        spec/helpers/templet/    # If --include-core-specs is given
+        spec/helpers/templet/
+        spec/suppoert/templet/

data/lib/generators/templet/core_rspec/core_rspec_generator.rb

@@ -1,65 +1,50 @@
 
 require_relative '../shared/core_helpers'
 
-class Templet::CoreRspecGenerator < Rails::Generators::Base
-  include Shared::CoreHelpers
+module Templet
+  class CoreRspecGenerator < Rails::Generators::Base
+    include Shared::CoreHelpers
 
-  PANEL_SUBDIR = 'panel/'
+    source_root File.expand_path('./', __FILE__)
+    desc
 
-  DESC = "Add specs for the templet core (default: false)"
-  class_option 'include-core-specs', type: :boolean, default: false, desc: DESC
+    def copy_templet_specs
+      if Dir.exists? core_default_dir
+        %i(shared core).each do |subdir|
+          directory spec_support_dir_source(subdir), spec_support_dir_target
+        end
 
-  source_root File.expand_path('./', __FILE__)
-  desc
+        directory spec_templet_dir_source, spec_templet_dir_target
 
-  def copy_app_panel_specs
-    directory app_panel_dir_source, app_panel_dir_target
-  end
-
-  def copy_templet_specs
-    if include_core_specs? and Dir.exists? core_default_dir
-      directory spec_support_dir_source, spec_support_dir_target
-
-      directory spec_templet_dir_source, spec_templet_dir_target
-
-      puts message_for_file_change
+        puts message_for_file_change
+      end
     end
-  end
 
-  private
-
-  def app_panel_dir_source
-    SOURCE_ROOT + SPEC_SUBDIR + PANEL_SUBDIR
-  end
-  def app_panel_dir_target
-    SPEC_SUBDIR + HELPERS_SUBDIR + APP_SUBDIR + PANEL_SUBDIR
-  end
-
-  def spec_templet_dir_source
-   SOURCE_ROOT + SPEC_SUBDIR + TEMPLET_SUBDIR
-  end
+    private
 
-  def spec_templet_dir_target
-   SPEC_SUBDIR + HELPERS_SUBDIR + TEMPLET_SUBDIR
-  end
+    def spec_templet_dir_source
+     SOURCE_ROOT + SPEC_SUBDIR + TEMPLET_SUBDIR
+    end
 
-  def spec_support_dir_source
-    SOURCE_ROOT + spec_support_dir + 'core/'
-  end
-  def spec_support_dir_target
-    spec_support_dir + TEMPLET_SUBDIR
-  end
+    def spec_templet_dir_target
+     SPEC_SUBDIR + HELPERS_SUBDIR + TEMPLET_SUBDIR
+    end
 
-  def include_core_specs?
-    options['include-core-specs']
-  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 message_for_file_change
-    %Q(
+    def message_for_file_change
+      %Q(
 If you get rspec failures you may need to change values in the file:
-  spec/support/templet/model_parent_helpers.rb
+    spec/support/templet/model_parent_helpers.rb
 Or if you'd rather just get rid of these failing tests run this:
-  $ rails generate templet:destroy --rm-core-rspec
+    $ rails generate templet:destroy --rm-core-rspec
 )
+    end
   end
 end
+

data/lib/generators/templet/destroy/USAGE

@@ -7,7 +7,7 @@ Description:
 
 Examples:
     # To get rid of the whole lot
-    rails generate templet:destroy -all
+    rails generate templet:destroy --all
 
     # To delete just the templet core tests - leaves everything else intact
     rails generate templet:destroy --only-core-rspec

data/lib/generators/templet/destroy/destroy_generator.rb

@@ -1,126 +1,129 @@
 
-class Templet::DestroyGenerator < Rails::Generators::Base
-  ALL_DESC = "Remove all files to do with this framework (default: false)"
-  class_option 'all', type: :boolean, default: false, desc: ALL_DESC
+module Templet
+  class DestroyGenerator < Rails::Generators::Base
+    ALL_DESC = "Remove all files to do with this framework (default: false)"
+    class_option 'all', type: :boolean, default: false, desc: ALL_DESC
 
-  CORE_DESC = "Remove all of the core (framework) files (default: false)"
-  class_option 'rm-core', type: :boolean, default: false, desc: CORE_DESC
+    CORE_DESC = "Remove all of the core (framework) files (default: false)"
+    class_option 'rm-core', type: :boolean, default: false, desc: CORE_DESC
 
-  APP_DESC = "Remove the application files under app/helpers/app/ and all tests (default: false)"
-  class_option 'rm-app', type: :boolean, default: false, desc: APP_DESC
+    APP_DESC = "Remove the application files under app/helpers/app/ and all tests (default: false)"
+    class_option 'rm-app', type: :boolean, default: false, desc: APP_DESC
 
-  SPEC_DESC = "Remove just the tests for the template core (default: false)"
-  class_option 'rm-core-rspec', type: :boolean, default: false, desc: SPEC_DESC
+    SPEC_DESC = "Remove just the tests for the template core (default: false)"
+    class_option 'rm-core-rspec', type: :boolean, default: false, desc: SPEC_DESC
 
-  DEST_DESC = 'The directory that the core code will be copied into'
-  class_option :dest, type: :string, aliases: "-d", default: '', desc: DEST_DESC
+    DEST_DESC = 'The directory that the core code will be copied into'
+    class_option :dest, type: :string, aliases: "-d", default: '', desc: DEST_DESC
 
-  source_root File.expand_path('.', __FILE__)
-  desc
+    source_root File.expand_path('.', __FILE__)
+    desc
 
-  def check
-    if rm_all? or rm_core_rspec? or rm_app? or rm_core?
-      unless yes? 'Please confirm that you are about to delete a slew of files?'
-        exit
-      end
-    else
-      generate 'templet:destroy --help'
+    def check
+      if rm_all? or rm_core_rspec? or rm_app? or rm_core?
+        unless yes? 'Please confirm that you are about to delete a slew of files?'
+          exit
+        end
+      else
+        generate 'templet:destroy --help'
 
-      puts 'Note that at least one option needs to be given'
+        puts 'Note that at least one option needs to be given'
 
-      exit
+        exit
+      end
     end
-  end
 
-  def rm_core
-    if core_delete?
-      rm %w(app/helpers/templet/ lib/templet/)
+    def rm_core
+      if core_delete?
+        rm %w(app/helpers/templet/ lib/templet/)
+        rm 'app/helpers/templet_helper.rb'
 
-      if ( dest = options['dest'] ).present?
-        rm dest
+        if ( dest = options['dest'] ).present?
+          rm dest
+        end
       end
     end
-  end
 
-  def rm_controller
-    if core_delete?
-      rm %w(app/controllers/templet/)
+    def rm_controller
+      if core_delete?
+        rm %w(app/controllers/templet/)
+      end
     end
-  end
 
-  def rm_helpers_rb
-    if core_delete?
+    def rm_helpers_rb
+      if core_delete?
+      end
     end
-  end
 
-  def rm_app_trees
-    if app_delete?
-      rm %w(app/helpers/app.rb app/helpers/templet_helper.rb)
+    def rm_app_trees
+      if app_delete?
+        rm 'app/helpers/app.rb'
 
-      rm 'app/helpers/app/'
+        rm 'app/helpers/app/'
 
-      rm %w(spec/helpers/app/ spec/support/templet/)
+        rm %w(spec/helpers/app/ spec/support/templet/)
 
-      rm %w(spec/apis/ spec/support/apis/)
+        rm %w(spec/apis/ spec/support/apis/)
 
-      puts "Note that any generated controllers won't have been removed"
-      puts "  You'll have to manually delete these yourself"
-      puts "  There may also be entries in config/routes.rb"
+        puts "Note that any generated controllers won't have been removed"
+        puts "  You'll have to manually delete these yourself"
+        puts "  There may also be entries in config/routes.rb"
+      end
     end
-  end
 
-  def rm_core_rspec
-    if rm_all? or rm_core? or rm_core_rspec?
-      rm %w(spec/helpers/templet/)
+    def rm_core_rspec
+      if rm_all? or rm_core? or rm_core_rspec?
+        rm %w(spec/helpers/templet/)
 
-      rm %w(spec/support/templet/rest_link_procs_assignments.rb
-            spec/support/templet/rest_link_procs_helpers.rb
-            spec/support/templet/model_parent_helpers.rb)
+        rm %w(spec/support/templet/rest_link_procs_assignments.rb
+              spec/support/templet/rest_link_procs_helpers.rb
+              spec/support/templet/model_parent_helpers.rb)
+      end
     end
-  end
 
-  private
+    private
 
-  def rm(*paths)
-    paths.flatten.compact.each do |path|
-      #puts "  #{exists?(path) ? '*' : '?'} #{path}"
+    def rm(*paths)
+      paths.flatten.compact.each do |path|
+        #puts "  #{exists?(path) ? '*' : '?'} #{path}"
 
-      remove_file path if exists?(path)
+        remove_file path if exists?(path)
+      end
     end
-  end
 
-  def exists?(path)
-    if not path or path.empty?
-      false
-    elsif path.include?('.') or path =~ /[A-Z]/ or not path.end_with?('/')
-      File.exists? path
-    else
-      Dir.exists? path
+    def exists?(path)
+      if not path or path.empty?
+        false
+      elsif path.include?('.') or path =~ /[A-Z]/ or not path.end_with?('/')
+        File.exists? path
+      else
+        Dir.exists? path
+      end
     end
-  end
 
-  def core_delete?
-    rm_all? or (rm_core? and not rm_core_rspec?)
-  end
+    def core_delete?
+      rm_all? or (rm_core? and not rm_core_rspec?)
+    end
 
-  def app_delete?
-    rm_all? or (rm_app? and not rm_core_rspec?)
-  end
+    def app_delete?
+      rm_all? or (rm_app? and not rm_core_rspec?)
+    end
 
-  def rm_core_rspec?
-    options['rm-core-rspec']
-  end
+    def rm_core_rspec?
+      options['rm-core-rspec']
+    end
 
-  def rm_app?
-    options['rm-app']
-  end
+    def rm_app?
+      options['rm-app']
+    end
 
-  def rm_core?
-    options['rm-core']
-  end
+    def rm_core?
+      options['rm-core']
+    end
 
-  def rm_all?
-    options['all']
+    def rm_all?
+      options['all']
+    end
   end
 end