authorized_rails_scaffolds 0.0.10 → 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d09c935f8d34bf09cb594ada693383b9eca38a74
+  data.tar.gz: d7b570dcd10a6a4755aef6bb727a5744dfcc1d90
+SHA512:
+  metadata.gz: 8fadb2e8a6f331e11e2efe73abfd4db41ae33ce182bd2d8f1bba7223b84fa31ac628a497a8b358a749414efc7483d8a867e9044a0762da290254be6fcf19add6
+  data.tar.gz: d82853f18b54c24777df0d27e4fa1715c635914f75ca8a69fb62d54ff38ab006f063dad1f3b4f5e3e6628b73c7593c8749fd739db334bc0f0276efa32947258b

data/README.md

@@ -22,32 +22,31 @@ Add this line to your application's Gemfile:
 
     gem 'authorized_rails_scaffolds', :group => :development
 
-And then execute:
+Create a initializer at `config/nitializers/authorized_rails_scaffolds.rb` containing:
 
-    $ bundle
+    if Rails.env.development? 
+    
+      AuthorizedRailsScaffolds.configure do |config|
+        # i.e. ['Category', 'User'] for Awesome/FooBar => awesome_category_user_foo_bars_path
+        config.parent_models = []
+      end
+      
+    end
 
-Or install it yourself as:
+And then execute:
 
-    $ gem install authorized_rails_scaffolds
+    $ bundle
+    $ rails g authorized_rails_scaffolds:install_templates
+    $ rails g authorized_rails_scaffolds:install_macros
 
 ## Usage
 
-`authorized_rails_scaffolds` is a development only gem that adds templates for quickly creating new controllers and views to be displayed primarily viewed with Twitter Bootstrap.
-
-Once you have run all the generators you want, you can remove the gem with no side effects.
-
-### Install Scaffold Templates
-
 `authorized_rails_scaffolds` provides a series of rails generators that replace the default scaffold templates generated by Rails.
 
 The generated Controllers require CanCan to be installed on your system, however it is possible change this behavour by uncommenting out the first line of each generated action manually.
 
 The generated Controller only handles Authorization and assumes Authentication is managed in the Application Controller or is added manually.
 
-You can install the generators by running:
-
-    $ rails generate authorized_rails_scaffolds:install_scaffold
-
 This gem doesn't override the default scaffold.css generated by `rails g scaffold`, however it works best with `rails g scaffold_controller`.
 
 For example:
@@ -55,18 +54,6 @@ For example:
     rails g model FooBar name:string age:integer date_of_birth:date lunch_time:time programmer:boolean joined_at:datetime
     rails g scaffold_controller Awesome/FooBar name:string age:integer date_of_birth:date lunch_time:time programmer:boolean joined_at:datetime
 
-### Install Spec Templates
-
-`authorized_rails_scaffolds` provides a series of rspec generators that replace the default controller and view spec templates generated by RSpec.
-
-You can install the generators by running:
-
-    $ rails generate authorized_rails_scaffolds:install_spec
-
-You will need to implement `login_unauthorized_user` and `login_user_with_ability` into your Controller specs.
-
-Installing Scaffold Controllers in Rails (`rails g scaffold_controller`) generates view and controller specs if RSpec is installed as a gem.
-
 ## Contributing
 
 1. Fork it

data/lib/authorized_rails_scaffolds.rb

@@ -22,7 +22,16 @@ module AuthorizedRailsScaffolds
 
 end
 
+require "authorized_rails_scaffolds/controller_macros"
+require "authorized_rails_scaffolds/factory_macros"
+require "authorized_rails_scaffolds/resource_macros"
+require "authorized_rails_scaffolds/route_example_macros"
+require "authorized_rails_scaffolds/test_var_macros"
 require "authorized_rails_scaffolds/helper"
-require "authorized_rails_scaffolds/rspec_scaffold_generator_helper"
-require "authorized_rails_scaffolds/rspec_scaffold_generator_view_helper"
+require "authorized_rails_scaffolds/rails_erb_scaffold_helper"
+require "authorized_rails_scaffolds/rails_scaffold_controller_helper"
+require "authorized_rails_scaffolds/rspec_scaffold_helper"
+require "authorized_rails_scaffolds/rspec_scaffold_controller_helper"
+require "authorized_rails_scaffolds/rspec_scaffold_routing_helper"
+require "authorized_rails_scaffolds/rspec_scaffold_view_helper"
 

data/lib/authorized_rails_scaffolds/controller_macros.rb

@@ -0,0 +1,22 @@
+#
+# requires modular_class_name to be defined
+#
+# also makes use of @controller_class_name value
+#
+module ControllerMacros
+
+  # The namespaced class the Controller inherits from (i.e. Example::ApplicationController)
+  def application_controller_class
+    @application_controller_class = 'ApplicationController'
+    if parent_modules.any?
+      @application_controller_class = "#{parent_modules.join('::')}::#{@application_controller_class}"
+    end
+    @application_controller_class
+  end
+
+  def controller_class_name
+    controller_class_prefix = @controller_class_name || modular_class_name.pluralize
+    "#{controller_class_prefix}Controller"
+  end
+
+end

data/lib/authorized_rails_scaffolds/factory_macros.rb

@@ -0,0 +1,65 @@
+module FactoryMacros
+
+  # Returns code that will generate attribute_value as an attribute_type
+  def factory_attribute_value(attribute_type, attribute_value)
+    case attribute_type
+    when :datetime
+      "DateTime.parse(#{attribute_value})"
+    when :time
+      value_as_time = attribute_value.to_time.strftime('%T')
+      "Time.parse(#{value_as_time.dump})"
+    when :date
+      value_as_date = attribute_value.to_time.strftime('%Y-%m-%d')
+      "Date.parse(#{value_as_date.dump})"
+    else
+      attribute_value
+    end
+  end
+
+  # Returns the expected output string of attribute_value if it is an attribute_type
+  def factory_attribute_string(attribute_type, attribute_value)
+    case attribute_type
+    when :datetime
+      attribute_value_as_date = DateTime.parse(attribute_value)
+      I18n.l(attribute_value_as_date, :format => :long).dump
+    when :time
+      attribute_value_as_time = Time.parse(attribute_value)
+      I18n.l(attribute_value_as_time, :format => :short).dump
+    when :date
+      attribute_value_as_date = Date.parse(attribute_value)
+      I18n.l(attribute_value_as_date).dump
+    else
+      attribute_value
+    end
+  end
+
+  def create_resource_from_factory
+    extra_factory_params = build_extra_factory_params
+    "FactoryGirl.create(#{resource_symbol}#{extra_factory_params})"
+  end
+
+  def create_parent_resource_from_factory(parent_table_name)
+    extra_factory_params = build_extra_factory_params(parent_table_name)
+    "FactoryGirl.create(:#{parent_table_name}#{extra_factory_params})"
+  end
+
+  protected
+
+  def build_extra_factory_params(parent_table_name = nil)
+    if parent_table_name.nil?
+      attribute = parent_model_tables.last
+    else
+      parent_index = parent_model_tables.index(parent_table_name.to_s)
+      unless parent_index.nil? || parent_index == 0
+        attribute = parent_model_tables[parent_index - 1]
+      end
+    end
+
+    if attribute.nil?
+      return ''
+    else
+      return ", :#{attribute} => #{references_test_property(attribute)}"
+    end
+  end
+
+end

data/lib/authorized_rails_scaffolds/helper.rb

@@ -1,38 +1,18 @@
 module AuthorizedRailsScaffolds
-  
   class Helper
+    include ResourceMacros
 
     def initialize(options = {})
-      @local_class_name = options[:local_class_name] || options[:class_name].split('::')[-1]
+      # @local_class_name = options[:local_class_name]
       @var_name = options[:var_name] || options[:file_name] # Non-namespaced variable name
-      @plural_var_name = options[:plural_var_name] || @var_name.pluralize # Pluralized non-namespaced variable name
-      # Determine namespace prefix i.e awesome
-      @namespace_prefix = options[:namespace_prefix] || options[:singular_table_name][0..-(@var_name.length + 2)]
-      @controller_prefix = options[:controller_prefix] || options[:class_name].split('::')[0..-2].join('::')
-
-      # Determine Parent Prefix i.e. user_company
-      parent_prefix = AuthorizedRailsScaffolds.config.parent_models.collect{ |x| x.underscore }.join('_')
-
-      # Route Prefix i.e. awesome_user_company
-      route_prefix = [@namespace_prefix, parent_prefix].reject{ |x|x.blank? }.join('_')
-      @route_prefix = route_prefix.blank? ? '' : "#{route_prefix}_"
-
-      @parent_variables = AuthorizedRailsScaffolds.config.parent_models.collect{ |x| "@#{x.underscore}" }.join(', ')
 
-      # Route Helpers
-      @route_params_prefix = @parent_variables.blank? ? "" : "#{@parent_variables}, "
-      @index_path_prefix = "#{@route_prefix}#{@plural_var_name}"
-      @single_path_prefix = "#{@route_prefix}#{var_name}"
-    end
+      # Pluralized non-namespaced variable name
+      @plural_var_name ||= options[:plural_var_name] || @var_name.pluralize
 
-    # Prefix for Controllers (i.e. Admin::)
-    def ns_controller_prefix
-      "#{@controller_prefix}::" unless @controller_prefix.blank?
-    end
+      # Determine namespace prefix i.e awesome
+      # options[:namespace_prefix]
 
-    # Non-namespaced class name (i.e. FooBar)
-    def local_class_name
-      @local_class_name
+      @singular_table_name = options[:singular_table_name]
     end
 
     # Non-namespaced variable name (i.e. foo_bar)
@@ -40,113 +20,56 @@ module AuthorizedRailsScaffolds
       @var_name
     end
 
-    # Pluralized non-namespaced variable name (i.e. foo_bars)
     def plural_var_name
       @plural_var_name
     end
 
-    def extra_params
-      extra_params = ''
-      AuthorizedRailsScaffolds.config.parent_models.each_with_index do |model, model_index|
-        extra_params += ", :#{model.underscore}_id => \"#{model_index + 2}\""
-      end
-      extra_params
+    # Route Prefix parts i.e. ['awesome', 'user', 'company']
+    def route_prefix_values
+      @route_prefix_values ||= [parent_module_groups + parent_model_tables]
     end
 
-    def form_object_array(variable = nil)
-      variable ||= "@#{var_name}"
-      namespace_prefix = ":#{@namespace_prefix}" unless @namespace_prefix.blank?
-      array = [namespace_prefix, @parent_variables, variable].reject{ |x| x.blank? || x == '_' }.join(', ')
-      "[#{array}]"
+    def collection_route_prefix
+      @collection_route_prefix ||= [route_prefix_values + [resource_table_name.pluralize]].join('_')
     end
 
-    def controller_show_route(variable = nil)
-      variable ||= ""
-      if variable.blank?
-        "#{@single_path_prefix}_path(#{@parent_variables})"
-      else
-        "#{@single_path_prefix}_path(#{@route_params_prefix}#{variable})"        
-      end
+    def member_route_prefix
+      @member_route_prefix ||= [route_prefix_values + [resource_table_name]].join('_')
     end
 
-    def controller_index_path
-      if @parent_variables.blank?
-        "#{@index_path_prefix}_path"
-      else
-        "#{@index_path_prefix}_path(#{@parent_variables})"
-      end
+    def parent_variables
+      @parent_variables ||= parent_model_tables.collect{ |parent_table| parent_variable(parent_table) }
     end
 
-    def controller_index_route
-      if @parent_variables.blank?
-        "#{@index_path_prefix}_url"
-      else
-        "#{@index_path_prefix}_url(#{@parent_variables})"
-      end
-    end
-
-    # call arguments
-    def index_action_params_prefix
-      if AuthorizedRailsScaffolds.config.parent_models.any?
-        AuthorizedRailsScaffolds.config.parent_models.collect{|x| ":#{x.underscore}_id => @#{x.underscore}.to_param"}.join(', ')
-      else
-        ''
-      end
+    def controller_show_route(variable = nil)
+      variables = [] + parent_variables
+      variables += [variable] unless variable.nil?
+      controller_routes = "#{member_route_prefix}_path"
+      controller_routes += "(#{variables.join(', ')})" if variables.any?
+      controller_routes
     end
 
-    def references_show_route(attribute_name, variable = nil)
-      variable ||= "@#{@var_name}.#{attribute_name}"
-      if AuthorizedRailsScaffolds.config.parent_models.any? && AuthorizedRailsScaffolds.config.parent_models.last.underscore == attribute_name
-        references_path = "#{@route_prefix}path(#{variable})"
-      else
-        references_path = "#{attribute_name}_path(#{variable})"
-        unless @namespace_prefix.blank?
-        references_path = "#{@namespace_prefix}_#{references_path}"
-      end
-      end
-      references_path
+    def controller_index_path
+      variables = parent_variables
+      controller_index_path = "#{collection_route_prefix}_path"
+      controller_index_path += "(#{variables.join(', ')})" if variables.any?
+      controller_index_path
     end
 
-    def action_params_prefix
-      index_action_params = index_action_params_prefix
-      if index_action_params.blank?
-        ''
-      else
-        "#{index_action_params}, "
-      end
+    def controller_index_route
+      variables = parent_variables
+      controller_index_route = "#{collection_route_prefix}_url"
+      controller_index_route += "(#{variables.join(', ')})" if variables.any?
+      controller_index_route
     end
 
-    # Returns code that will generate attribute_value as an attribute_type
-    def factory_attribute_value(attribute_type, attribute_value)
-      case attribute_type
-      when :datetime
-        "DateTime.parse(#{attribute_value})"
-      when :time
-        value_as_time = attribute_value.to_time.strftime('%T')
-        "Time.parse(#{value_as_time.dump})"
-      when :date
-        value_as_date = attribute_value.to_time.strftime('%Y-%m-%d')
-        "Date.parse(#{value_as_date.dump})"
-      else
-        attribute_value
-      end
-    end
+    def references_show_route(attribute_name, variable = nil)
+      variable ||= "#{resource_var}.#{attribute_name}"
+      path_variables = [parent_module_groups + [attribute_name]]
 
-    # Returns the expected output string of attribute_value if it is an attribute_type
-    def factory_attribute_string(attribute_type, attribute_value)
-      case attribute_type
-      when :datetime
-        attribute_value_as_date = DateTime.parse(attribute_value)
-        I18n.l(attribute_value_as_date, :format => :long).dump
-      when :time
-        attribute_value_as_time = Time.parse(attribute_value)
-        I18n.l(attribute_value_as_time, :format => :short).dump
-      when :date
-        attribute_value_as_date = Date.parse(attribute_value)
-        I18n.l(attribute_value_as_date).dump
-      else
-        attribute_value
-      end
+      references_show_route = path_variables.join('_')
+      references_show_route += "_path(#{variable})"
+      references_show_route
     end
 
   end

data/lib/authorized_rails_scaffolds/rails_erb_scaffold_helper.rb

@@ -0,0 +1,40 @@
+class AuthorizedRailsScaffolds::RailsErbScaffoldHelper < AuthorizedRailsScaffolds::Helper
+
+  def initialize(options = {})
+    super options
+
+    @modular_class_name = options[:class_name] || options[:local_class_name]
+  end
+
+  # returns values that should be parsed by a form in order for post and put actions to work
+  def scoped_values_for_form(variable = nil)
+    variable ||= resource_var
+
+    form_argument_values = []
+
+    # Add the modules
+    parent_module_groups.each do |parent_module|
+      form_argument_values << ":#{parent_module}"
+    end
+
+    # Add the models
+    parent_model_tables.each do |parent_model|
+      form_argument_values << "@#{parent_model}"
+    end
+
+    form_argument_values << variable
+
+    if form_argument_values.count == 1
+      return variable
+    else
+      "[#{form_argument_values.join(', ')}]"
+    end
+  end
+
+  # Class name with parent modules included (i.e. Example::FooBar)
+  # Name of class assumed by default generators, used as a base for determining modules and class
+  def modular_class_name
+    @modular_class_name
+  end
+
+end

data/lib/authorized_rails_scaffolds/rails_scaffold_controller_helper.rb

@@ -0,0 +1,20 @@
+class AuthorizedRailsScaffolds::RailsScaffoldControllerHelper < AuthorizedRailsScaffolds::Helper
+  include ControllerMacros
+  include RouteExampleMacros
+
+  def initialize(options = {})
+    super options
+
+    # Modularized class name generated by spec generator
+    @controller_class_name = options[:controller_class_name]
+
+    @modular_class_name = options[:class_name] || options[:local_class_name]
+  end
+
+  # Class name with parent modules included (i.e. Example::FooBar)
+  # Name of class assumed by default generators, used as a base for determining modules and class
+  def modular_class_name
+    @modular_class_name
+  end
+
+end

data/lib/authorized_rails_scaffolds/resource_macros.rb

@@ -0,0 +1,81 @@
+#
+# requires modular_class_name to be defined
+#
+module ResourceMacros
+
+  ### Base Resource ###
+
+  # Class name of the resource being tested (i.e. 'FooBar')
+  def resource_class
+    # @local_class_name
+    @resource_class ||= modular_class_name.split('::')[-1]
+  end
+
+  # Table name of the Resource being tested (i.e. foo_bar)
+  def resource_table_name
+    @resource_table_name ||= resource_class.underscore
+  end
+
+  # Symbol used to represent resource (i.e. :foo_bar)
+  def resource_symbol
+    ":#{resource_table_name}"
+  end
+
+  # Name for plural of a resource
+  def resource_plural_name
+    @resource_plural_name ||= plural_var_name || (var_name || resource_table_name).pluralize
+  end
+
+  def resource_plural_sym
+    ":#{resource_plural_name}"
+  end
+
+  # Variable resource is assigned to in a singular context (i.e. @foo_bar)
+  def resource_var
+    @resource_var_name ||= "@#{var_name || resource_table_name}"
+  end
+
+  # Variable resource is assigned to in a plural context (i.e. @foo_bars)
+  def resources_var
+    @resource_var_name ||= "@#{resource_plural_name}"
+  end
+
+  # Directory of the current resource: i.e. awesome/foo_bars
+  def resource_directory
+    @resource_directory = [parent_module_groups + [resource_table_name.pluralize]].join("/")
+  end
+
+  ### Parent Models ###
+
+  # An array of parent model classes (i.e. ['User', 'Category])
+  def parent_models
+    @parent_models ||= AuthorizedRailsScaffolds.config.parent_models
+  end
+
+  # Table names of parent models (i.e. ['user', 'category'])
+  def parent_model_tables
+    @parent_model_tables ||= parent_models.map { |model| model.underscore }
+  end
+
+  # Variable name used to save a parent_table_name
+  def parent_variable(parent_table_name)
+    "@#{parent_table_name}"
+  end
+  
+  def parent_sym(parent_table_name)
+    ":#{parent_table_name}"
+  end
+
+  ### Parent Modules ###
+
+  # The parent modules of a controller (i.e. ['Api', 'V1'])
+  def parent_modules
+    @parent_modules ||= modular_class_name.split('::')[0..-2]
+  end
+
+  # Array of symbols used for links to parents (i.e. ['api', 'v1'])
+  def parent_module_groups
+    @parent_module_groups ||= parent_modules.map { |parent_module| parent_module.underscore }
+  end
+
+end