benhoskings-hammock 0.3.9 → 0.3.10

data/History.txt

@@ -1,3 +1,21 @@
+== 0.3.10 2009-07-19
+Updated to newgem v1.5.1.
+Sort componenets before requiring, for consistent require order.
+Added preliminary prefix and singleton support to RouteStep, renaming 'resource' to 'node' (since it's a RouteNode).
+Added preliminary prefix and singleton resource support to RouteNode.
+Redesigned scope lookups to choose verb-specific scopes whenever possible, defaulting to :read or :write depending whether the route is safe.
+Added RouteStep#default_verb.
+Cleaned up RouteNode#base_for, using Array#pick.
+Added RouteNode#default_verb_for.
+Added RouteNode#safe_for?.
+Improved error message in RouteNode#for.
+Added RouteNote#all_routes hash.
+Added Array#pick - like #detect, but returns the result of the block instead of the original element.
+Use #camelize instead of #classify in Hammock.load_models, to avoid changing the plurality.
+Added block support to Array#discard[!].
+Removed unneeded self. calls from ArrayPatches.
+
+
 == 0.3.9 2009-06-18
 Improved logging in find_record_on_create.
 Enabled :indicate_current support in #hamlink_to, using RouteStep#matches?.

data/Rakefile

@@ -1,29 +1,21 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-%w[action_controller].each { |f| require f }
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require 'action_controller'
 require File.dirname(__FILE__) + '/lib/hammock'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('hammock', Hammock::VERSION) do |p|
-  p.developer('Ben Hoskings', 'ben@hoskings.net')
-  p.changes         = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.rubyforge_name  = p.name
-  p.extra_deps      = [
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+$hoe = Hoe.spec 'hammock' do
+  self.developer 'Ben Hoskings', 'ben@hoskings.net'
+  self.extra_deps = [
     ['rails', '~> 2.2'],
     ['benhoskings-ambitious-activerecord', '~> 0.1.3.7'],
   ]
-  p.extra_dev_deps  = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
+require 'newgem/tasks'
 Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]

data/hammock.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hammock}
-  s.version = "0.3.9"
+  s.version = "0.3.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Hoskings"]
-  s.date = %q{2009-06-18}
+  s.date = %q{2009-07-19}
   s.description = %q{Hammock is a Rails plugin that eliminates redundant code in a very RESTful manner. It does this in lots in lots of different places, but in one manner: it encourages specification in place of implementation.
 
 
@@ -18,7 +18,7 @@ Hammock inspects your routes and resources to generate a routing tree for each r
 
 It makes more sense when you see how it works though. There's a screencast coming soon.}
   s.email = ["ben@hoskings.net"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc", "misc/scaffold.txt"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "misc/scaffold.txt"]
   s.files = ["History.txt", "LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "hammock.gemspec", "init.rb", "lib/hammock.rb", "lib/hammock/ajaxinate.rb", "lib/hammock/callback.rb", "lib/hammock/callbacks.rb", "lib/hammock/canned_scopes.rb", "lib/hammock/constants.rb", "lib/hammock/controller_attributes.rb", "lib/hammock/export_scope.rb", "lib/hammock/hamlink_to.rb", "lib/hammock/javascript_buffer.rb", "lib/hammock/lambda_alias.rb", "lib/hammock/lambda_composition.rb", "lib/hammock/logging.rb", "lib/hammock/model_attributes.rb", "lib/hammock/model_logging.rb", "lib/hammock/monkey_patches/action_pack.rb", "lib/hammock/monkey_patches/active_record.rb", "lib/hammock/monkey_patches/array.rb", "lib/hammock/monkey_patches/hash.rb", "lib/hammock/monkey_patches/logger.rb", "lib/hammock/monkey_patches/module.rb", "lib/hammock/monkey_patches/numeric.rb", "lib/hammock/monkey_patches/object.rb", "lib/hammock/monkey_patches/route_set.rb", "lib/hammock/monkey_patches/string.rb", "lib/hammock/mutex.rb", "lib/hammock/overrides.rb", "lib/hammock/resource_mapping_hooks.rb", "lib/hammock/resource_retrieval.rb", "lib/hammock/restful_actions.rb", "lib/hammock/restful_rendering.rb", "lib/hammock/restful_support.rb", "lib/hammock/route_drawing_hooks.rb", "lib/hammock/route_for.rb", "lib/hammock/route_node.rb", "lib/hammock/route_step.rb", "lib/hammock/scope.rb", "lib/hammock/suggest.rb", "lib/hammock/utils.rb", "misc/scaffold.txt", "misc/template.rb", "tasks/hammock_tasks.rake", "test/hammock_test.rb"]
   s.homepage = %q{http://github.com/benhoskings/hammock}
   s.rdoc_options = ["--main", "README.rdoc"]
@@ -34,18 +34,15 @@ It makes more sense when you see how it works though. There's a screencast comin
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, ["~> 2.2"])
       s.add_runtime_dependency(%q<benhoskings-ambitious-activerecord>, ["~> 0.1.3.7"])
-      s.add_development_dependency(%q<newgem>, [">= 1.4.1"])
-      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+      s.add_development_dependency(%q<hoe>, [">= 2.3.2"])
     else
       s.add_dependency(%q<rails>, ["~> 2.2"])
       s.add_dependency(%q<benhoskings-ambitious-activerecord>, ["~> 0.1.3.7"])
-      s.add_dependency(%q<newgem>, [">= 1.4.1"])
-      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+      s.add_dependency(%q<hoe>, [">= 2.3.2"])
     end
   else
     s.add_dependency(%q<rails>, ["~> 2.2"])
     s.add_dependency(%q<benhoskings-ambitious-activerecord>, ["~> 0.1.3.7"])
-    s.add_dependency(%q<newgem>, [">= 1.4.1"])
-    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    s.add_dependency(%q<hoe>, [">= 2.3.2"])
   end
 end

data/lib/hammock/export_scope.rb

@@ -9,12 +9,12 @@ module Hammock
 
     module ClassMethods
 
-      def has_public_scope? scope_name
-        "#{scope_name}able" if respond_to? "#{scope_name}_scope"
+      def public_scope_for verb
+        "#{verb}able" if respond_to? "#{verb}_scope"
       end
 
-      def has_account_scope? scope_name
-        "#{scope_name}able_by" if respond_to? "#{scope_name}_scope_for"
+      def user_scope_for verb
+        "#{verb}able_by" if respond_to? "#{verb}_scope_for"
       end
 
       def export_scopes *verbs

data/lib/hammock/monkey_patches/array.rb

@@ -22,18 +22,25 @@ module Hammock
         self[-other.length, other.length] == other
       end
 
+      def pick &block
+        value = nil
+        detect {|i| value = yield(i) }
+        value
+      end
+
       def squash
-        self.dup.squash!
+        dup.squash!
       end
       def squash!
-        self.delete_if &:blank?
+        delete_if &:blank?
       end
 
-      def discard *args
-        self.dup.discard! *args
+      def discard *args, &block
+        dup.discard! *args, &block
       end
-      def discard! *args
-        args.each {|arg| self.delete arg }
+      def discard! *args, &block
+        args.each {|arg| delete arg }
+        each {|i| delete(i) if yield(i) } if block_given?
         self
       end
 
@@ -55,7 +62,7 @@ module Hammock
         this_method = methods.shift
 
         # First, hash this array into +hsh+.
-        self.each {|i| hsh[i.send(this_method)] << i }
+        each {|i| hsh[i.send(this_method)] << i }
 
         if methods.empty?
           # If there are no methods remaining, yield this group to the block if required.

data/lib/hammock/resource_retrieval.rb

@@ -69,14 +69,14 @@ module Hammock
         elsif :readonly == reason
           escort_for_read_only
         elsif :unauthed == reason
-          if current_user.nil? && request.get? && account_verb_scope?
+          if current_user.nil? && request.get? && current_user_scope
             # This request may be available after a login, and can be replayed
             redirect_to returning_login_path
           else
             # TODO Write a 403 partial.
             render_for_status 404
           end
-        elsif current_user.nil? && account_verb_scope?
+        elsif current_user.nil? && current_user_scope
           escort_for_login
         else
           render_for_status 404

data/lib/hammock/restful_support.rb

@@ -145,10 +145,6 @@ module Hammock
         end
       end
 
-      def safe_verb_and_implication?
-        request.get? && !action_name.to_sym.in?(Hammock::Constants::ImpliedUnsafeActions)
-      end
-
       def set_editing
         @editing = @record
       end

data/lib/hammock/route_node.rb

@@ -15,11 +15,13 @@ module Hammock
       :create => :post
     }.freeze
 
-    attr_reader :mdl, :resource, :parent, :children, :routing_parent, :record_routes, :resource_routes, :build_routes
+    attr_reader :mdl, :resource, :parent, :children, :prefix, :routing_parent, :record_routes, :resource_routes, :build_routes, :all_routes
 
     def initialize entity = nil, options = {}
       @parent = options[:parent]
       @children = {}
+      @options = options[:name_prefix]
+      @singleton = options[:singleton]
       unless root?
         @mdl = entity if entity.is_a?(Symbol)
         @routing_parent = determine_routing_parent
@@ -32,16 +34,28 @@ module Hammock
       Object.const_get mdl.to_s.classify rescue nil
     end
 
+    def default_verb_for verb
+      safe_for?(verb) ? :read : :write
+    end
+
     def root?
       parent.nil?
     end
 
+    def safe_for? verb
+      (:get == all_routes[verb]) && !verb.in?(Hammock::Constants::ImpliedUnsafeActions)
+    end
+
+    def singleton?
+      @singleton
+    end
+
     def ancestry
       root? ? [] : parent.ancestry.push(self)
     end
 
     def for verb, entities, options
-      raise "Hammock::RouteNode#for requires an explicitly specified verb as its first argument." unless verb.is_a?(Symbol)
+      raise "Hammock::RouteNode#for requires a verb (as a symbol) as its first argument." unless verb.is_a?(Symbol)
       raise "Hammock::RouteNode#for requires an Array of at least one record or resource." if entities.empty? || !entities.is_a?(Array)
 
       entity = entities.shift
@@ -54,22 +68,16 @@ module Hammock
     end
 
     def base_for resources
-      # puts "base_for<#{mdl}>: resources=#{resources.inspect}."
       if resources.empty?
-        self
+        if root?
+          raise "You have to supply at least one valid resource to find its routing base."
+        else
+          self
+        end
       else
-        match = nil
-        children.values.detect {|child|
-          # puts "  Trying #{child.ancestry.map(&:mdl).inspect} for #{resources.inspect}"
-          if !resources.include?(child.mdl)
-            # puts "  Can't match #{resources.inspect} against #{child.mdl}."
-            nil
-          else
-            # puts "  Matched #{child.mdl} from #{resources.inspect}."
-            match = child.base_for resources.discard(child.mdl)
-          end
-        } #|| raise("There is no routing path for #{resources.map(&:inspect).inspect}.")
-        match
+        children.values.pick {|child|
+          child.base_for resources.discard(child.mdl) if resources.include?(child.mdl)
+        }
       end
     end
 
@@ -89,13 +97,19 @@ module Hammock
       eval "resource.select {|r| r.#{resource.routing_attribute} == value }"
     end
 
-    def add entity, options, steps = nil
-      if steps.nil?
-        add entity, options, (options[:name_prefix] || '').chomp('_').split('_').map {|i| i.pluralize.underscore.to_sym }
-      elsif steps.empty?
+    def add_singleton entity, options, path_steps = nil
+      add entity, options.merge(:singleton => true), path_steps
+    end
+
+    def add entity, options, path_steps = nil
+      # puts "add(#{entity.inspect}, #{options.inspect}, #{path_steps.inspect})"
+      if path_steps.nil?
+        path_steps = (options[:path_prefix] || '').split('/').squash.discard {|i| i.starts_with? ':' }.map(&:to_sym)
+        add entity, options, path_steps
+      elsif path_steps.empty?
         add_child entity, options
       else
-        children[steps.shift].add entity, options, steps
+        children[path_steps.shift].add entity, options, path_steps
       end
     end
 
@@ -115,6 +129,7 @@ module Hammock
       @record_routes = DefaultRecordVerbs.dup.update(options[:member] || {})
       @resource_routes = DefaultResourceVerbs.dup.update(options[:collection] || {})
       @build_routes = DefaultBuildVerbs.dup.update(options[:build] || {})
+      @all_routes = @record_routes.merge(@resource_routes).merge(@build_routes)
     end
 
     def determine_routing_parent

data/lib/hammock/route_step.rb

@@ -1,13 +1,13 @@
 module Hammock
   class RouteStep
-    attr_reader :resource, :routeable_as, :verb, :entity, :parent
+    attr_reader :node, :routeable_as, :verb, :entity, :parent
 
-    def initialize resource
-      @resource = resource
+    def initialize node
+      @node = node
     end
 
     def for verb, entity
-      routeable_as = resource.routeable_as(verb, entity)
+      routeable_as = node.routeable_as(verb, entity)
 
       if !routeable_as
         raise "The verb '#{verb}' can't be applied to " + (entity.record? ? "#{entity.resource} records" : "the #{entity.resource} resource") + "."
@@ -40,8 +40,15 @@ module Hammock
       raise_unless_setup_while_trying_to 'render a path'
 
       buf = '/'
-      buf << entity.resource_name
-      buf << '/' + entity.to_param if entity.record? && !entity.new_record?
+      buf << node.prefix unless node.prefix.nil?
+
+      if node.singleton?
+        buf << entity.resource_name.singularize
+      else
+        buf << entity.resource_name
+        buf << '/' + entity.to_param if entity.record? && !entity.new_record?
+      end
+
       buf << '/' + verb.to_s unless verb.nil? or implied_verb?(verb)
 
       buf = parent.path + buf unless parent.nil?
@@ -52,7 +59,7 @@ module Hammock
 
     def http_method
       raise_unless_setup_while_trying_to 'extract the HTTP method'
-      resource.send("#{routeable_as}_routes")[verb]
+      node.send("#{routeable_as}_routes")[verb]
     end
 
     def fake_http_method
@@ -68,6 +75,10 @@ module Hammock
       get? && !verb.in?(Hammock::Constants::ImpliedUnsafeActions)
     end
 
+    def default_verb
+      safe? ? :read : :write
+    end
+
     private
 
     def implied_verb? verb

data/lib/hammock/scope.rb

@@ -42,35 +42,25 @@ module Hammock
         raise "The verb at #{call_point} must be supplied as a Symbol." unless verb.nil? || verb.is_a?(Symbol)
         route = route_for verb, record
         if route.verb.in?(:save, :create) && record.new_record?
-          if !record.createable_by?(current_user)
-            dlog "#{requester_name} can't create a #{record.class} with #{record.attributes.inspect}. #{describe_call_point 4}"
-            :unauthed
-          else
-            :ok
+          returning record.createable_by?(current_user) ? :ok : :unauthed do |result|
+            dlog "#{requester_name} can#{"'t" unless result == :ok} create a #{record.class} with #{record.attributes.inspect}. #{describe_call_point 4}"
           end
         else
-          if !record.readable_by?(current_user)
-            dlog "#{requester_name} can't see #{record.class}<#{record.id}>. #{describe_call_point 4}"
-            :not_found
-          elsif !route.safe? && !record.writeable_by?(current_user)
-            dlog "#{requester_name} can't #{verb} #{record.class}<#{record.id}>. #{describe_call_point 4}"
-            :read_only
-          else
-            # dlog "#{requester_name} can #{verb} #{record.class}<#{record.id}>."
-            :ok
+          returning record.send("#{scope_for_route(route)}?", current_user) ? :ok : :not_found do |result|
+            dlog "#{requester_name} can#{"'t" unless result == :ok} #{verb} #{record.class}<#{record.id}>. #{describe_call_point 4}"
           end
         end
       end
 
       def current_verb_scope
-        if current_user && (scope_name = account_verb_scope?)
-          # dlog "got an account_verb_scope #{scope_name}."
+        if current_user && (scope_name = current_user_scope)
+          # dlog "current_user_scope is #{scope_name}."
           mdl.send scope_name, current_user
-        elsif !(scope_name = public_verb_scope?)
-          log "No #{current_user.nil? ? 'public' : 'account'} #{scope_name_for_action} scope available for #{mdl}.#{' May be available after login.' if account_verb_scope?}"
+        elsif !(scope_name = current_public_scope)
+          log "No #{current_user.nil? ? 'public' : 'account'} #{action_name} scope available for #{mdl}.#{' May be available after login.' if current_user_scope}"
           nil
         else
-          # dlog "got a #{scope_name} public_verb_scope."
+          # dlog "current_public_scope is #{scope_name}."
           mdl.send scope_name
         end
       end
@@ -101,25 +91,20 @@ module Hammock
 
       private
 
-      def scope_name_for_action
-        if 'index' == action_name
-          'index'
-        elsif safe_verb_and_implication?
-          'read'
-        else
-          'write'
-        end
-      end
-
       def requester_name
         current_user.nil? ? 'Anonymous' : "#{current_user.class}<#{current_user.id}>"
       end
 
-      def account_verb_scope?
-        mdl.has_account_scope?(action_name) || mdl.has_account_scope?(scope_name_for_action)
+      def current_user_scope
+        mdl.user_scope_for(action_name) || mdl.user_scope_for(current_hammock_resource.default_verb_for(action_name))
+      end
+      def current_public_scope
+        mdl.public_scope_for(action_name) || mdl.public_scope_for(current_hammock_resource.default_verb_for(action_name))
       end
-      def public_verb_scope?
-        mdl.has_public_scope?(action_name) || mdl.has_public_scope?(scope_name_for_action)
+
+      def scope_for_route route
+        method_name = current_user.nil? ? :public_scope_for : :user_scope_for
+        mdl.send(method_name, route.verb) || mdl.send(method_name, route.default_verb)
       end
 
     end

data/lib/hammock.rb

@@ -4,7 +4,7 @@ require 'ambition'
 require 'ambition/adapters/active_record'
 
 module Hammock
-  VERSION = '0.3.9'
+  VERSION = '0.3.10'
   IncludeTarget = ActionController::Base
 
   def self.included base # :nodoc:
@@ -21,7 +21,7 @@ module Hammock
   # and related methods always return the full set of models they should.
   def self.load_models
     Dir.glob(RAILS_ROOT / 'app/models/**/*.rb').each {|model_file|
-      klass = File.basename(model_file, '.rb').classify
+      klass = File.basename(model_file, '.rb').camelize
       begin
         Object.const_get klass
       rescue
@@ -39,7 +39,7 @@ module Hammock
   end
 
   def self.require_hammock_components
-    Dir.glob("#{File.dirname __FILE__}/hammock/**/*.rb").each {|dep|
+    Dir.glob("#{File.dirname __FILE__}/hammock/**/*.rb").sort.each {|dep|
       require dep
     }
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: benhoskings-hammock
 version: !ruby/object:Gem::Version 
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors: 
 - Ben Hoskings
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-18 00:00:00 -07:00
+date: 2009-07-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,16 +32,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.1.3.7
     version: 
-- !ruby/object:Gem::Dependency 
-  name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.4.1
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -50,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 2.3.2
     version: 
 description: "Hammock is a Rails plugin that eliminates redundant code in a very RESTful manner. It does this in lots in lots of different places, but in one manner: it encourages specification in place of implementation.   Hammock enforces RESTful resource access by abstracting actions away from the controller in favour of a clean, model-like callback system.  Hammock tackles the hard and soft sides of security at once with a scoping security system on your models. Specify who can verb what resources under what conditions once, and everything else - the actual security, link generation, index filtering - just happens.  Hammock inspects your routes and resources to generate a routing tree for each resource. Parent resources in a nested route are handled transparently at every point - record retrieval, creation, and linking.  It makes more sense when you see how it works though. There's a screencast coming soon."
 email: 
@@ -62,7 +52,6 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.rdoc
 - misc/scaffold.txt
 files: 
 - History.txt