stateful_link 0.0.1 → 0.0.2

data/Gemfile

@@ -4,8 +4,11 @@ gem "rails", ">= 3"
 gem "capybara", ">= 0.3.9"
 gem "sqlite3-ruby", :require => "sqlite3"
 
-if RUBY_VERSION < '1.9'
-  gem "ruby-debug", ">= 0.10.3"
+group :development, :test do
+  gem 'childprocess'
+  if RUBY_VERSION < '1.9'
+    gem "ruby-debug", ">= 0.10.3"
+  end
 end
 
 gem "rspec-rails", ">= 2.0.0.beta"

data/Gemfile.lock

@@ -114,7 +114,8 @@ PLATFORMS
 
 DEPENDENCIES
   capybara (>= 0.3.9)
-  rails (~> 3)
+  childprocess
+  rails (>= 3)
   rspec-rails (>= 2.0.0.beta)
   ruby-debug (>= 0.10.3)
   sqlite3-ruby

data/README.rdoc

@@ -3,11 +3,13 @@
 StatefulLink is a helper that simplifies displaying stateful navigation links. State
 depends on current controller and action.
 
-= Installation
+== Installation
 
-gem 'stateful_link', :git => 'git://github.com/gzigzigzeo/stateful_link.git'
+Rails3 only Add the following line to your Gemfile:
 
-= Examples
+  gem 'stateful_link'
+
+== Examples
 
 Let we have RESTful PostsController and two navigation links in layout.
 
@@ -40,7 +42,7 @@ Solution:
         stateful_link(
           active, 
           chosen,
-          :active => proc { label ),
+          :active => proc { label },
           :chosen => proc { content_tag :b, link_to(label, url) },
           :inactive => proc { link_to label, url }
         )
@@ -51,9 +53,9 @@ Solution:
 
     <ul>
       <li>
-        <%= navigation_link("Posts", "posts/index", "posts/*", posts_url) %>
+        <%= navigation_link("Posts", "posts#index", "posts#*", posts_url) %>
         <ul>
-          <%= navigation_link("New post", ["posts/new", "posts/create"], nil, new_post_url) %>
+          <%= navigation_link("New post", ["posts#new", "posts#create"], nil, new_post_url) %>
         </ul>
       </li>
     </ul>

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake'
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-Rspec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 
 begin
@@ -13,7 +13,7 @@ begin
     gem.summary = "Helper to generate stateful navigation links."
     gem.description = "Helper to generate stateful navigation links."
     gem.files =  FileList["[A-Z]*", "lib/**/*"]
-    gem.version = "0.0.1"
+    gem.version = "0.0.2"
     gem.email = "gzigzigzeo@gmail.com"
     gem.authors = ["Victor Sokolov"]
     gem.homepage = "http://github.com/gzigzigzeo/stateful_link"

data/lib/stateful_link.rb

@@ -1,4 +1,5 @@
 module StatefulLink
+  require 'stateful_link/helper'
+  require 'stateful_link/action_any_of'
   require 'stateful_link/railtie' if defined?(Rails)
-  require 'stateful_link/helper'  
 end

data/lib/stateful_link/action_any_of.rb

@@ -0,0 +1,79 @@
+module StatefulLink
+  module ActionAnyOf#:doc:
+    extend ActiveSupport::Concern    
+
+    included do
+      helper_method :action_any_of?, :extract_controller_and_action, :action_state if respond_to?(:helper_method)
+    end
+    
+    module InstanceMethods
+      # Returns true if current controller and action names equals to any of passed.
+      # Asterik as action name matches all controller's action.
+      #
+      # Examples:
+      #   <%= "we are in PostsController::index" if action_any_of?("posts#index") %>
+      #
+      #   <%= "we are not in PostsController::index" unless action_any_of?("posts#index") %>
+      #
+      #   <% if action_any_of?("posts#index", "messages#index") %>
+      #     we are in PostsController or in MessagesController
+      #   <% end %>
+      #
+      def action_any_of?(*actions)
+        actions.any? do |sub_ca|
+          unless sub_ca.empty?
+            sub_controller, sub_action = extract_controller_and_action(sub_ca)
+            self.controller_path == sub_controller && (self.action_name == sub_action || (sub_action == '' || sub_action == '*'))
+          end
+        end
+      end
+    
+      # Extracts controller and action names from a string.
+      #
+      # Examples:
+      #
+      #   extract_controller_and_action("posts#index")       # ["posts", "index"]
+      #   extract_controller_and_action("admin/posts#index") # ["admin/posts", "index"]
+      #   extract_controller_and_action("admin/posts#index") # raises ArgumentError
+      #
+      def extract_controller_and_action(ca)
+        raise ArgumentError, "Pass the string" if ca.nil?
+        slash_pos = ca.rindex('#')
+        raise ArgumentError, "Invalid action: #{ca}" if slash_pos.nil?
+        controller = ca[0, slash_pos]
+        action = ca[slash_pos+1..-1] || ""
+        raise ArgumentError, "Invalid action or controller" if controller.nil?
+
+        [controller, action]
+      end        
+    
+      # Returns link state related to current controller and action: :inactive, :active or :chosen.
+      # A list of active actions is the first argument, chosen actions are the second argument.
+      #
+      # Examples:
+      #   # :active for PostsController::index, :chosen for PostsController::* (except :index), 
+      #   # :inactive otherwise.
+      #   action_state("posts#index", "posts#")
+      #   
+      #   # :active for PostsController::new and PostsController::create, :inactive otherwise.
+      #   action_state(["posts#new", "posts#create"])
+      #
+      #   # :active for PostsController::index, :chosen for MessagesController::* and
+      #   # PostsController::* (except :index), :inactive otherwise.
+      #   action_state("posts#index", ["posts#", "messages#"])
+      #
+      def action_state(active, chosen = nil)
+        active = active.is_a?(String) ? [active] : active
+        chosen = chosen.is_a?(String) ? [chosen] : chosen
+
+        if action_any_of?(*active)
+          :active
+        elsif !chosen.nil? && action_any_of?(*chosen) 
+          :chosen
+        else
+          :inactive    
+        end
+      end    
+    end
+  end
+end

data/lib/stateful_link/helper.rb

@@ -1,73 +1,5 @@
 module StatefulLink
-  module Helper#:doc:
-    # Returns true if current controller and action names equals to any of passed.
-    # Asterik as action name matches all controller's action.
-    #
-    # Examples:
-    #   <%= "we are in PostsController::index" if action_any_of?("posts#index") %>
-    #
-    #   <%= "we are not in PostsController::index" unless action_any_of?("posts#index") %>
-    #
-    #   <% if action_any_of?("posts#index", "messages#index") %>
-    #     we are in PostsController or in MessagesController
-    #   <% end %>
-    #
-    def action_any_of?(*actions)
-      actions.any? do |sub_ca|
-        sub_controller, sub_action = extract_controller_and_action(sub_ca)
-        controller.controller_path == sub_controller && (controller.action_name == sub_action || sub_action == '')
-      end
-    end
-
-    # Returns link state related to current controller and action: :inactive, :active or :chosen.
-    # A list of active actions is the first argument, chosen actions are the second argument.
-    #
-    # Examples:
-    #   # :active for PostsController::index, :chosen for PostsController::* (except :index), 
-    #   # :inactive otherwise.
-    #   action_state("posts#index", "posts#")
-    #   
-    #   # :active for PostsController::new and PostsController::create, :inactive otherwise.
-    #   action_state(["posts#new", "posts#create"])
-    #
-    #   # :active for PostsController::index, :chosen for MessagesController::* and
-    #   # PostsController::* (except :index), :inactive otherwise.
-    #   action_state("posts#index", ["posts#", "messages#"])
-    #
-    def action_state(active, chosen = nil)
-      active = active.is_a?(String) ? [active] : active
-      chosen = chosen.is_a?(String) ? [chosen] : chosen
-
-      if action_any_of?(*active)
-        :active
-      else
-        if !chosen.nil? && action_any_of?(*chosen) 
-          :chosen
-        else
-          :inactive    
-        end    
-      end
-    end
- 
-    # Extracts controller and action names from a string.
-    #
-    # Examples:
-    #
-    #   extract_controller_and_action("posts#index")       # ["posts", "index"]
-    #   extract_controller_and_action("admin/posts#index") # ["admin/posts", "index"]
-    #   extract_controller_and_action("admin/posts#index") # raises ArgumentError
-    #
-    def extract_controller_and_action(ca)
-      raise ArgumentError, "Pass the string" if ca.nil?
-      slash_pos = ca.rindex('#')
-      raise ArgumentError, "Invalid action: #{ca}" if slash_pos.nil?
-      controller = ca[0, slash_pos]
-      action = ca[slash_pos+1..-1] || ""
-      raise ArgumentError, "Invalid action or controller" if controller.nil?
-
-      [controller, action]
-    end
-    
+  module Helper#:doc:   
     # Generates stateful link to something.
     # 
     # Options:
@@ -97,4 +29,4 @@ module StatefulLink
       current.is_a?(Proc) ? instance_exec(&current) : current
     end
   end
-end
+end

data/lib/stateful_link/railtie.rb

@@ -1,7 +1,8 @@
 module StatefulLink
   class Railtie < ::Rails::Railtie
     config.to_prepare do
-      ApplicationController.helper(StatefulLink::Helper)
+      ActionController::Base.send(:include, StatefulLink::ActionAnyOf)
+      ActionController::Base.helper(StatefulLink::Helper)
     end  
   end
 end

data/spec/controllers/action_any_of_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ApplicationController do
+  it "should extract controller and action" do    
+    subject.extract_controller_and_action("friendships#index").should == ['friendships', 'index']
+    subject.extract_controller_and_action("friendships#").should == ['friendships', '']    
+  end
+  
+  it "action_any_of should work" do
+    get :index
+    subject.action_any_of?("bars#index").should be_false
+    subject.action_any_of?("application#index").should be_true
+    subject.action_any_of?("bars#index", "application#index").should be_true    
+  end
+  
+  it "action_state should work" do
+    get :index
+    subject.action_state("bars#index", "application#index").should == :chosen
+    subject.action_state("bars#index", ["application#index", "foobars#index"]).should == :chosen    
+    subject.action_state("application#index", "tests#index").should == :active
+    subject.action_state("application#index").should == :active    
+  end  
+end

data/spec/helpers/stateful_link_spec.rb

@@ -2,28 +2,11 @@ require 'spec_helper'
 
 describe StatefulLink::Helper do
   before(:each) do
+    ActionView::Base.send(:include, StatefulLink::ActionAnyOf)
     controller.controller_path = 'foos'
-    controller.action_name = 'bar'    
-  end
+    controller.action_name = 'bar'
+  end    
 
-  it "should extract controller and action" do
-    helper.extract_controller_and_action("friendships#index").should == ['friendships', 'index']
-    helper.extract_controller_and_action("friendships#").should == ['friendships', '']    
-  end
-  
-  it "action_any_of should work" do
-    helper.action_any_of?("bars#index").should be_false
-    helper.action_any_of?("foos#bar").should be_true
-    helper.action_any_of?("bars#index", "foos#bar").should be_true    
-  end
-  
-  it "action_state should work" do
-    helper.action_state("bars#index", "foos#bar").should == :chosen
-    helper.action_state("bars#index", ["foos#", "foobars#index"]).should == :chosen    
-    helper.action_state("foos#bar", "tests#index").should == :active
-    helper.action_state("foos#bar").should == :active    
-  end
-  
   it "should generate stateful links" do
     helper.stateful_link_to(
       "foos#bar",
@@ -39,6 +22,15 @@ describe StatefulLink::Helper do
       :inactive => "2",
       :chosen => proc { root_path }
     ).should == root_path
+
+    # Check for controller#*
+    helper.stateful_link_to(
+      "bars#foo",
+      ["foos#trala", "foos#*"],
+      :active => "1",
+      :inactive => "2",
+      :chosen => "3"
+    ).should == "3"
     
     helper.stateful_link_to(
       :active => "1",
@@ -54,4 +46,4 @@ describe StatefulLink::Helper do
       :state => proc { false }
     ).should == "2"
   end
-end
+end

data/spec/spec_helper.rb

@@ -22,7 +22,7 @@ ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
-Rspec.configure do |config|
+RSpec.configure do |config|
   # Remove this line if you don't want Rspec's should and should_not
   # methods or matchers
   require 'rspec/expectations'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stateful_link
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Victor Sokolov
@@ -15,13 +15,103 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-11 00:00:00 +03:00
+date: 2011-01-21 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
   name: rails
+  requirement: *id001
+  type: :runtime
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 3
+        - 9
+        version: 0.3.9
+  name: capybara
+  requirement: *id002
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: sqlite3-ruby
+  requirement: *id003
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31098209
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        version: 2.0.0.beta
+  name: rspec-rails
+  requirement: *id004
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: childprocess
+  requirement: *id005
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 10
+        - 3
+        version: 0.10.3
+  name: ruby-debug
+  requirement: *id006
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,8 +122,9 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
+  name: rails
+  requirement: *id007
   type: :runtime
-  version_requirements: *id001
 description: Helper to generate stateful navigation links.
 email: gzigzigzeo@gmail.com
 executables: []
@@ -49,8 +140,10 @@ files:
 - README.rdoc
 - Rakefile
 - lib/stateful_link.rb
+- lib/stateful_link/action_any_of.rb
 - lib/stateful_link/helper.rb
 - lib/stateful_link/railtie.rb
+- spec/controllers/action_any_of_spec.rb
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/config/application.rb
@@ -72,8 +165,8 @@ homepage: http://github.com/gzigzigzeo/stateful_link
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -102,6 +195,7 @@ signing_key:
 specification_version: 3
 summary: Helper to generate stateful navigation links.
 test_files: 
+- spec/controllers/action_any_of_spec.rb
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/config/application.rb