authorized_rails_scaffolds 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c307ff40cc7d76b304b65af1a46ac08010c04ebd
-  data.tar.gz: 2aafb9e88c59ebc6c0d616b55df02aa2181b459a
+  metadata.gz: 48159be8830cab29219981b558c48f647cac5651
+  data.tar.gz: 31db50aea7a19dfa206edc4b9eb0dcff5e20d48a
 SHA512:
-  metadata.gz: a7f7f59ee4d5fbe7211fd1ac6cd062741f0e450d5f4e4ebb63fd6fc56643d98463fdc6e4239d63da783ad4e25dba3ad86edbd6c1437d0cb041f19813c459c756
-  data.tar.gz: d99f4cb9d11e25bdf85785d30ba56d6f575ee13c642feec2f40cff0cf8c3f7db9417f6fa2ac05b9978ed55ded60750ebe2f758a2998f23f2f6eae4d10f44242d
+  metadata.gz: 01f6d37305d7e270d045d18f833130b14ed50086bd8e03b83e1364496272437dc8a0d7e2d1e06ae536aca9c6e519626d8ad8271af7be6c353353feaf93e0a1fa
+  data.tar.gz: 90483813b42dbb7437d30f4e56782782988babdf1423c7825d3dabfefdcdc9a225c6cdf172fe97767ece17a211cbd371e4a92d4bb7214b872af6a817ef88f997

data/README.md

@@ -29,6 +29,9 @@ Create a initializer at `config/initializers/authorized_rails_scaffolds.rb` cont
       AuthorizedRailsScaffolds.configure do |config|
         # i.e. ['Category', 'User'] for Awesome/FooBar => awesome_category_user_foo_bars_path
         config.parent_models = []
+
+        # toggles if shallow routes should be used
+        config.shallow_routes = false
       end
       
     end

data/lib/authorized_rails_scaffolds.rb

@@ -1,14 +1,21 @@
 require "authorized_rails_scaffolds/version"
 
 module AuthorizedRailsScaffolds
+
+  # Configuration Value Property
   class Configuration
     attr_accessor :parent_models
+    attr_accessor :shallow_routes
 
     def initialize
       self.parent_models = []
+      self.shallow_routes = false
     end
   end
 
+  # Mounting point for macros
+  module Macros; end
+
   def self.config
     @config ||= Configuration.new
   end
@@ -22,16 +29,26 @@ 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/macros/controller_macros"
+require "authorized_rails_scaffolds/macros/factory_macros"
+require "authorized_rails_scaffolds/macros/path_macros"
+require "authorized_rails_scaffolds/macros/parent_macros"
+require "authorized_rails_scaffolds/macros/resource_macros"
+require "authorized_rails_scaffolds/macros/route_example_macros"
+require "authorized_rails_scaffolds/macros/test_var_macros"
 require "authorized_rails_scaffolds/helper"
-require "authorized_rails_scaffolds/rails_erb_scaffold_helper"
+
+# Rails Helpers
 require "authorized_rails_scaffolds/rails_scaffold_controller_helper"
+require "authorized_rails_scaffolds/rails_helper_helper"
+
+# Erb Helpers
+require "authorized_rails_scaffolds/rails_erb_scaffold_helper"
+
+# RSpec Helpers
 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"
+require "authorized_rails_scaffolds/rspec_integration_helper"
 

data/lib/authorized_rails_scaffolds/helper.rb

@@ -1,10 +1,17 @@
 module AuthorizedRailsScaffolds
   class Helper
-    include ResourceMacros
+    include Macros::ParentMacros
+    include Macros::PathMacros
+    include Macros::ResourceMacros
 
     def initialize(options = {})
       # @local_class_name = options[:local_class_name]
-      @var_name = options[:var_name] || options[:file_name] # Non-namespaced variable name
+
+      # Fix for potentially plural file_name value
+      file_name = options[:file_name]
+      file_name = file_name.singularize unless file_name.nil?
+
+      @var_name = options[:var_name] || file_name # Non-namespaced variable name
 
       # Pluralized non-namespaced variable name
       @plural_var_name ||= options[:plural_var_name]
@@ -13,6 +20,8 @@ module AuthorizedRailsScaffolds
       # options[:namespace_prefix]
 
       @singular_table_name = options[:singular_table_name]
+
+      @human_name = options[:human_name]
     end
 
     # Non-namespaced variable name (i.e. foo_bar)
@@ -24,59 +33,9 @@ module AuthorizedRailsScaffolds
       @plural_var_name
     end
 
-    # Route Prefix parts i.e. ['awesome', 'user', 'company']
-    def route_prefix_values
-      unless @route_prefix_values
-        @route_prefix_values = parent_module_groups || []
-        @route_prefix_values += parent_model_tables
-        @route_prefix_values = @route_prefix_values.reject{|x|x.blank?}
-      end
-      @route_prefix_values
-    end
-
-    def collection_route_prefix
-      @collection_route_prefix ||= (route_prefix_values + [resource_table_name.pluralize]).join('_')
-    end
-
-    def member_route_prefix
-      @member_route_prefix ||= (route_prefix_values + [resource_table_name]).join('_')
-    end
-
-    def parent_variables
-      @parent_variables ||= parent_model_tables.collect{ |parent_table| parent_variable(parent_table) }
-    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 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 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
-
-    def references_show_route(attribute_name, variable = nil)
-      variable ||= "#{resource_var}.#{attribute_name}"
-      path_variables = [parent_module_groups + [attribute_name]]
-
-      references_show_route = path_variables.join('_')
-      references_show_route += "_path(#{variable})"
-      references_show_route
+    def shallow_routes?
+      !!AuthorizedRailsScaffolds.config.shallow_routes
     end
 
   end
-  
 end

data/lib/authorized_rails_scaffolds/{controller_macros.rb → macros/controller_macros.rb}

@@ -3,7 +3,7 @@
 #
 # also makes use of @controller_class_name value
 #
-module ControllerMacros
+module AuthorizedRailsScaffolds::Macros::ControllerMacros
 
   # The namespaced class the Controller inherits from (i.e. Example::ApplicationController)
   def application_controller_class

data/lib/authorized_rails_scaffolds/{factory_macros.rb → macros/factory_macros.rb}

@@ -1,4 +1,4 @@
-module FactoryMacros
+module AuthorizedRailsScaffolds::Macros::FactoryMacros
 
   # Returns code that will generate attribute_value as an attribute_type
   def factory_attribute_value(attribute_type, attribute_value)
@@ -47,18 +47,18 @@ module FactoryMacros
 
   def build_extra_factory_params(parent_table_name = nil)
     if parent_table_name.nil?
-      attribute = parent_model_tables.last
+      attribute = parent_model_names.last
     else
-      parent_index = parent_model_tables.index(parent_table_name.to_s)
+      parent_index = parent_model_names.index(parent_table_name.to_s)
       unless parent_index.nil? || parent_index == 0
-        attribute = parent_model_tables[parent_index - 1]
+        attribute = parent_model_names[parent_index - 1]
       end
     end
 
     if attribute.nil?
       return ''
     else
-      return ", :#{attribute} => #{references_test_property(attribute)}"
+      return ", :#{attribute} => #{references_test_name(attribute)}"
     end
   end
 

data/lib/authorized_rails_scaffolds/macros/parent_macros.rb

@@ -0,0 +1,56 @@
+module AuthorizedRailsScaffolds::Macros::ParentMacros
+
+  ### 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_names
+    @parent_model_names ||= 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
+
+  def parent_variables(use_shallow_route=false)
+    @parent_variables ||= parent_model_names.collect{ |parent_table| parent_variable(parent_table) }
+    use_shallow_route ? @parent_variables[0..-2] : @parent_variables
+  end
+
+  ### Parent Modules ###
+
+  # The parent modules of a controller (i.e. ['Api', 'V1'])
+  def parent_modules
+    @parent_modules ||= modular_class_name.nil? ? [] : 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
+
+  # Returns the parent model required to create the model
+  def model_parent_name(model_name)
+    if model_name == resource_name
+      return parent_model_names.any? ? parent_model_names.last : nil
+    else
+      parent_index = parent_model_names.index(model_name.to_s)
+      if parent_index.nil? || parent_index == 0
+        return nil
+      else
+        return parent_model_names[parent_index - 1]
+      end
+    end
+    
+  end
+
+end

data/lib/authorized_rails_scaffolds/macros/path_macros.rb

@@ -0,0 +1,70 @@
+module AuthorizedRailsScaffolds::Macros::PathMacros
+
+  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 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
+
+  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 controller_show_route(variable)
+    variables = []
+    variables += parent_variables(shallow_routes?)
+    variables += [variable] unless variable.nil?
+    controller_routes = "#{member_route_prefix(shallow_routes?)}_path"
+    controller_routes += "(#{variables.join(', ')})" if variables.any?
+    controller_routes
+  end
+
+  def controller_edit_route(variable)
+    "edit_#{controller_show_route(variable)}"
+  end
+
+  def controller_new_route
+    controller_routes = "#{member_route_prefix}_path"
+    controller_routes += "(#{parent_variables.join(', ')})" if parent_variables.any?
+    "new_#{controller_routes}"
+  end
+
+  def references_show_route(attribute_name, variable = nil)
+    variable ||= "#{resource_var}.#{attribute_name}"
+    path_variables = [parent_module_groups + [attribute_name]]
+
+    references_show_route = path_variables.join('_')
+    references_show_route += "_path(#{variable})"
+    references_show_route
+  end
+
+  protected
+
+  # Route Prefix parts i.e. ['awesome', 'user', 'company']
+  def route_prefix_values(use_shallow_route=false)
+    route_prefix_values = parent_module_groups || []
+    route_prefix_values += use_shallow_route ? parent_model_names[0..-2] : parent_model_names
+    route_prefix_values = route_prefix_values.reject{|x|x.blank?}
+  end
+
+  def collection_route_prefix
+    @collection_route_prefix ||= (route_prefix_values + [resource_array_name]).join('_')
+  end
+
+  def member_route_prefix(use_shallow_route=false)
+    (route_prefix_values(use_shallow_route) + [resource_name]).join('_')
+  end
+
+end

data/lib/authorized_rails_scaffolds/macros/resource_macros.rb

@@ -0,0 +1,53 @@
+#
+# requires modular_class_name to be defined
+#
+module AuthorizedRailsScaffolds::Macros::ResourceMacros
+
+  ### Base Resource ###
+
+  # Human name of the resource being tested (i.e. 'Foo bar')
+  def resource_human_name
+    @resource_human_name ||= @human_name || resource_name.titleize.humanize
+  end
+
+  # Class name of the resource being tested (i.e. 'FooBar')
+  def resource_class
+    # @local_class_name
+    @resource_class ||= (modular_class_name.nil? ? nil : modular_class_name.split('::')[-1]) || var_name.classify
+  end
+
+  # Table name of the Resource being tested (i.e. foo_bar)
+  def resource_name
+    @resource_name ||= (var_name || resource_class.underscore)
+  end
+
+  # Symbol used to represent resource (i.e. :foo_bar)
+  def resource_symbol
+    @resource_symbol ||= ":#{resource_name}"
+  end
+
+  # Variable resource is assigned to in a singular context (i.e. @foo_bar)
+  def resource_var
+    @resource_var ||= "@#{resource_name}"
+  end
+
+  # Name for plural of a resource
+  def resource_array_name
+    @resource_array_name ||= (plural_var_name || resource_name.pluralize)
+  end
+
+  # Variable resource is assigned to in a plural context (i.e. @foo_bars)
+  def resource_array_var
+    @resource_array_var ||= "@#{resource_array_name}"
+  end
+
+  def resource_array_sym
+    @resource_array_sym ||= ":#{resource_array_name}"
+  end
+
+  # Directory of the current resource: i.e. awesome/foo_bars
+  def resource_directory
+    @resource_directory = ((parent_module_groups || []) + [resource_array_name]).join("/")
+  end
+
+end

data/lib/authorized_rails_scaffolds/macros/route_example_macros.rb

@@ -0,0 +1,65 @@
+module AuthorizedRailsScaffolds::Macros::RouteExampleMacros
+
+  # Example index route: i.e. /awesome/users/2/foo_bars
+  def example_index_path
+    unless @example_index_path
+      example_index_path_parts = []
+
+      parent_model_names.each do |parent_model|
+        # users, 2
+        parent_value = example_parent_values["#{parent_model}_id"]
+        example_index_path_parts << parent_model.pluralize
+        example_index_path_parts << parent_value
+      end
+
+      # Example index route: i.e. /awesome/users/2/foo_bars
+      @example_index_path = [parent_module_groups + example_index_path_parts + [resource_array_name]].join("/")
+    end
+    "/#{@example_index_path}"
+  end
+
+  def example_show_path
+    unless @example_show_path
+      example_show_path_parts = []
+
+      parent_names = shallow_routes? ? parent_model_names[0..-2] : parent_model_names
+      parent_names.each do |parent_model|
+        # users, 2
+        parent_value = example_parent_values["#{parent_model}_id"]
+        example_show_path_parts << parent_model.pluralize
+        example_show_path_parts << parent_value
+      end
+
+      # Example index route: i.e. /awesome/users/2/foo_bars
+      @example_show_path = [parent_module_groups + example_show_path_parts + [resource_array_name]].join("/")
+    end
+    "/#{@example_show_path}/1"
+  end
+
+  # Extra params for an example controller path: i.e. ', :user_id => 2'
+  def example_index_path_extra_params
+    @example_index_path_extra_params ||= example_parent_values.map{ |parent_model_id, parent_value| ", :#{parent_model_id} => \"#{parent_value}\"" }.join('')
+  end
+
+  def example_show_path_extra_params
+    @example_show_path_extra_params ||= example_parent_values(shallow_routes?).map{ |parent_model_id, parent_value| ", :#{parent_model_id} => \"#{parent_value}\"" }.join('')
+  end
+
+  def example_route_extra_params(use_shallow_route=false)
+    @example_route_extra_params ||= parent_model_names.collect{ |parent_table| ":#{parent_table}_id => #{references_test_name(parent_table)}.to_param" }
+    use_shallow_route ? @example_route_extra_params[0..-2] : @example_route_extra_params
+  end
+
+  protected
+
+  # Creates example values for parent id params (i.e. :user_id => 2)
+  def example_parent_values(use_shallow_route=false)
+    example_parent_values = {}
+    parent_models = use_shallow_route ? parent_model_names[0..-2] : parent_model_names
+    parent_models.each_with_index do |parent_model, index|
+      example_parent_values["#{parent_model}_id"] = index + 2
+    end
+    example_parent_values
+  end
+
+end