langalex-components 0.0.2 → 0.0.3

data/{README → README.md}

@@ -1,4 +1,4 @@
-= Components
+## Components
 
 This plugin attempts to implement components in the simplest, cleanest, fastest way possible. Inspired by the Cells plugin (http://cells.rubyforge.org) by Nick Sutterer and Peter Bex.
 
@@ -6,129 +6,143 @@ A component can be thought of as a very lightweight controller with supporting v
 
 Speaking imprecisely, components prepare for and then render templates.
 
-== Usage
+## Usage
 
 Note that these examples are very simplistic and would be better implemented using Rails partials.
 
-=== Generator
+### Generator
 
 Running `script/generator users details` will create a UsersComponent with a "details" view. You might then flesh out the templates like this:
 
-  class UsersComponent < Components::Base
-    def details(user_or_id)
-      @user = user_or_id.is_a?(User) ? user_or_id : User.find(user_or_id)
-      render
+    class UsersComponent < Components::Base
+      def details(user_or_id)
+        @user = user_or_id.is_a?(User) ? user_or_id : User.find(user_or_id)
+        render
+      end
     end
-  end
 
-=== From ActionController
+### From ActionController
 
-  class UsersController < ApplicationController
-    def show
-      return :text => component("users/detail", params[:id])
+    class UsersController < ApplicationController
+      def show
+        return :text => component("users/detail", params[:id])
+      end
     end
-  end
 
-=== From ActionView
+### From ActionView
 
-  <%= component "users/detail", @user %>
+    <%= component "users/detail", @user %>
 
-== More Features
+## More Features
 
-=== Caching
+### Caching
 
 Any component action may be cached using the fragment caching you've configured on ActionController::Base. The command to cache a component action must come after the definition of the action itself. This is because the caching method wraps the action, which makes the caching work even if you call the action directly.
 
 Example:
 
-  class UsersComponent < Components::Base
-    def details(user_id)
-      @user = User.find(user_id)
-      render
+    class UsersComponent < Components::Base
+      def details(user_id)
+        @user = User.find(user_id)
+        render
+      end
+      cache :details, :expires_in => 15.minutes
     end
-    cache :details, :expires_in => 15.minutes
-  end
 
 This will cache the returns from UsersComponent#details using a cache key like "users/details/5", where 5 is the user_id. The cache will only be good for fifteen minutes. See Components::Caching for more information.
 
-=== Helpers
+### Helpers
 
 All of the standard helper functionality exists for components. You may define a method on your component controller and use :helper_method to make it available in your views, or you may use :helper to add entire modules of extra methods to your views.
 
 Be careful importing existing helpers, though, as some of them may try and break encapsulation by reading from the session, the request, or the params. You may need to rewrite these helpers so they accept the necessary information as arguments.
 
-=== Inherited Views
+### Inherited Views
 
 Assume two components:
 
-  class ParentComponent < Components::Base
-    def one
-      render
-    end
+    class ParentComponent < Components::Base
+      def one
+        render
+      end
 
-    def two
-      render
+      def two
+        render
+      end
     end
-  end
 
-  class ChildComponent < ParentComponent
-    def one
-      render
-    end
+    class ChildComponent < ParentComponent
+      def one
+        render
+      end
 
-    def three
-      render "one"
+      def three
+        render "one"
+      end
     end
-  end
 
 Both methods on the ChildComponent class would first try and render "/app/components/child/one.erb", and if that file did not exist, would render "/app/components/parent/one.erb".
 
-=== Standard Argument Options
+### Standard Argument Options
 
 You may find yourself constantly needing to pass a standard set of options to each component. If so, you can define a method on your controller that returns a hash of standard options that will be merged with the component arguments and passed to every component.
 
 Suppose a given component:
 
-  class GroupsComponent < Components::Base
-    def details(group_id, options = {})
-      @user = options[:user]
-      @group = Group.find(group_id)
-      render
+    class GroupsComponent < Components::Base
+      def details(group_id, options = {})
+        @user = options[:user]
+        @group = Group.find(group_id)
+        render
+      end
     end
-  end
 
 Then the following setup:
 
-  class GroupsController < ApplicationController
-    def show
-      render :text => component("groups/details", params[:id])
-    end
+    class GroupsController < ApplicationController
+      def show
+        render :text => component("groups/details", params[:id])
+      end
 
-    protected
+      protected
 
-    def standard_component_options
-      {:user => current_user}
+      def standard_component_options
+        {:user => current_user}
+      end
     end
-  end
 
 Would expand to:
 
-  component("groups/details", params[:id], :user => current_user)
+    component("groups/details", params[:id], :user => current_user)
 
-== Components Philosophy
+## Components Philosophy
 
 I wrote this components plugin after evaluating a couple of existing ones, reflecting a bit, and either stealing or composing the following principles. I welcome all debate on the subject.
 
-=== Components <em>should not</em> simply embed existing controller actions.
+### Components <em>should not</em> simply embed existing controller actions.
 
 Re-using existing controller actions introduces intractable performance problems related to redundant controller filters and duplicate request-cached variables.
 
-=== Components <em>should not</em> have the concept of a "request" or "current user".
+### Components <em>should not</em> have the concept of a "request" or "current user".
 
 Everything should be provided as an argument to the component - it should not have direct access to the session, the params, or any other aspect of the request. This means that components will never intelligently respond_to :html, :js, :xml, etc.
 
-=== Components _should_ complement RESTful controller design.
+### Components _should_ complement RESTful controller design.
 
 The path of least resistance in Rails includes RESTful controller design to reduce code redundancy. Components should only be designed for use cases where RESTful controller design is either awkward or impossible. This compatibility will reduce the maintenance effort for components and help them grow with Rails itself.
 
+## Troubleshooting
+
+Q: I want to render partials from my app/views directory in a component view but it doesn't work  
+A: You have to add the view path of your normal views to the view paths of the components. One solution would be to overwrite the `view_paths` method in your component:
+
+    def self.view_paths
+      super + [Rails.root + 'app/views']
+    end
+
+Q: I want to use a method from one of my helpers in app/helpers but I get a method missing error  
+A: Call `helper :all` in your component, just like you would in a controller
+
+## Copyright
+
 Copyright (c) 2008 Lance Ivy, released under the MIT license

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 0
-:patch: 2
+:patch: 3

data/components.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{components}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lance Ivy", "Alexander Lang"]
-  s.date = %q{2009-06-19}
+  s.date = %q{2009-08-26}
   s.email = %q{alex@upstream-berlin.com}
   s.extra_rdoc_files = [
-    "README"
+    "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "MIT-LICENSE",
-     "README",
+     "README.md",
      "Rakefile",
      "VERSION.yml",
      "components.gemspec",

data/lib/components/caching.rb

@@ -159,6 +159,8 @@ module Components::Caching
           arg.to_param
       end
     end.join('/')
+    
+    key = Digest::MD5.hexdigest(key) if key.length > 200
 
     ActiveSupport::Cache.expand_cache_key(key, :components)
   end

data/test/caching_test.rb

@@ -19,6 +19,7 @@ class CachingTest < Test::Unit::TestCase
     assert_equal "components/hello_world/say_it/trumpapum", @component.send(:cache_key, :say_it, ["trumpapum"]), "uses arguments"
     assert_equal "components/hello_world/say_it/a/1/2/3/foo=bar", @component.send(:cache_key, :say_it, ["a", [1,2,3], {:foo => :bar}]), "handles mixed types"
     assert_equal "components/hello_world/say_it/a=1&b=2", @component.send(:cache_key, :say_it, [{:b => 2, :a => 1}]), "hash keys are ordered"
+    assert_equal "components/834876df77918cf2bbfb42253d5977aa", @component.send(:cache_key, :say_it, [{:a => 'x' * 190}]), "hash keys are MD5ed when too long"
   end
 
   def test_conditional_caching

data/test/test_helper.rb

@@ -19,6 +19,6 @@ RAILS_DEFAULT_LOGGER = Logger.new(File.dirname(__FILE__) + '/debug.log')
   ActiveSupport::Dependencies.load_paths << File.dirname(__FILE__) + "/" + load_path
 end
 
-require File.dirname(__FILE__) + '/../init'
+require File.dirname(__FILE__) + '/../rails/init'
 
 ActionController::Base.cache_store = :memory_store

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: langalex-components
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Lance Ivy
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-19 00:00:00 -07:00
+date: 2009-08-26 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -21,12 +21,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 files: 
 - .document
 - .gitignore
 - MIT-LICENSE
-- README
+- README.md
 - Rakefile
 - VERSION.yml
 - components.gemspec
@@ -59,6 +59,7 @@ files:
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/langalex/components
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: TODO