cells-collection 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 459248934c448a5cdce15676b038b66c1cae5309
+  data.tar.gz: 7f150d4c455faccec2f4f571a7d9f0a881420450
+SHA512:
+  metadata.gz: fac847494f6b6ea3c881a6134292a37f6fcd0b4369032518badebd59da36d55a30d4957ece806dad573e439bb3264678f826543ba9b21f45ee0a8546297905c2
+  data.tar.gz: 7a906a51f7bb23c305ccfa78197ea0ad01cd1a1c07a4795f391bf88e062cf3a2dfa022ef2e6331a32896c8a9db30c129a03df0a49c47eed359e9c04913cf2929

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cells-collection.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 lulalala
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Cells::Collection
+
+Allows [cell](https://github.com/apotonick/cells) rendering for a collection of items in one go.
+
+This allows Rails to utilize cache store's `get_multi` method. When cache store supports it (e.g. Memcached), this results in only one cache read request for the whole collection.
+
+The performance boost does vary from action to action, so always benchmark to see if it improved the performance. Two biggest boost can happen when:
+
+* Cache store lives at a remote location.
+* Collection size over 50 items.
+
+## Installation
+
+Add this line to your application's Gemfile **after** cells gem declaration:
+
+    gem 'cells'
+    gem 'cells-collection'
+
+And then execute:
+
+    $ bundle install
+
+To setup Rails to use Memcached store, take look at the [dalli gem](https://github.com/mperham/dalli).
+
+## Usage
+
+Doing this in the view:
+
+    <%= render_cell_collection :cart, :item, @items %>
+
+will be equivalent to the old:
+
+    <% @items.each do |item| %>
+      <%= render_cell :cart, :item, item %>
+    <% end %>
+
+If the cell requires more arguments, they can be passed at the end. They will be passed to each cell rendering too:
+
+    <%= render_cell_collection :cart, :item, @items, 'hot', 10 %>
+
+is equivalent to:
+
+    <% @items.each do |item| %>
+      <%= render_cell :cart, :item, item, 'hot', 10 %>
+    <% end %>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new

data/cells-collection.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cells-collection/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cells-collection"
+  spec.version       = Cells::Collection::VERSION
+  spec.authors       = ["GoodLife", "lulalala"]
+  spec.email         = ["mark@goodlife.tw"]
+  spec.description   = %q{Cells rendering for a collection of items, utilizing cache bulk-read.}
+  spec.summary       = %q{Cells rendering for a collection of items}
+  spec.homepage      = "https://github.com/GoodLife/cells-collection"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'cells', '~> 3.8'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/lib/cells-collection.rb

@@ -0,0 +1,4 @@
+require "cells-collection/version"
+require "cells-collection/cells/rails"
+require 'cells-collection/cell/rendering'
+require 'cells-collection/cell/caching'

data/lib/cells-collection/cell/caching.rb

@@ -0,0 +1,63 @@
+require 'active_support/cache'
+
+module Cell
+  module Caching
+    module ClassMethods
+      def render_cell_collection_for(name, state, *args)
+        args_for_single = args.dup
+        collection = args[1]
+
+        return '' if collection.empty?
+
+        item_to_key = {}
+        item_to_key.compare_by_identity
+        item_to_cell = {} # Cache initialized cell object
+        item_to_cell.compare_by_identity
+
+        # Create item-key mapping table for cacheable cells
+        collection.each do |item|
+          args_for_single[1] = item # Prepare args for single item
+          cell = create_cell_for(name, *args_for_single)
+
+          item_to_cell[item] = cell
+
+          if cell.cache?(state, *args)
+            # Remove first arg, because compute_key does not want the cell object as first argument.
+            # I don't know where is this stripped in single cell rendering code.
+            item_to_key[item] = cell.compute_key(state, *(args_for_single[1..-1]))
+          end
+        end
+
+        # cache.read_multi & cache.write interfaces may require mutable keys, ie. dalli 2.6.0
+        mutable_keys = item_to_key.values.map(&:dup)
+
+        if options = cache_options[state]
+          cached = cache_store.read_multi(*mutable_keys, options)
+        else
+          cached = cache_store.read_multi(*mutable_keys)
+        end
+
+        rendered = ''
+
+        collection.each do |item|
+          # Get key of item, and check if cached has that key
+          if cached_result = cached[item_to_key[item]]
+            rendered << cached_result
+          else
+            cell = item_to_cell[item]
+            yield cell if block_given?
+
+            args_for_single[1] = item # Prepare args for single item
+            rendered << render_cell_state(cell, state, *args_for_single)
+          end
+        end
+
+        return rendered.html_safe
+      end
+    end
+
+    def compute_key(state, *args)
+      self.class.state_cache_key(state, call_state_versioner(state, *args))
+    end
+  end
+end

data/lib/cells-collection/cell/rendering.rb

@@ -0,0 +1,24 @@
+module Cell
+  module Rendering
+    module ClassMethods
+      # Rendering collection of cells
+      def render_cell_collection_for(name, state, *args)
+        args_for_single = args.dup
+        collection = args[1]
+
+        rendered = ''
+
+        collection.each do |item|
+          args_for_single[1] = item
+
+          cell = create_cell_for(name, *args_for_single)
+          yield cell if block_given?
+
+          rendered << render_cell_state(cell, state, *args_for_single)
+        end
+
+        return rendered.html_safe
+      end
+    end
+  end
+end

data/lib/cells-collection/cells/rails.rb

@@ -0,0 +1,15 @@
+module Cells
+  module Rails
+    module ActionController
+      def render_cell_collection(name, state, *args, &block)
+        ::Cell::Rails.render_cell_collection_for(name, state, self, *args, &block)
+      end
+    end
+
+    module ActionView
+      def render_cell_collection(name, state, *args, &block)
+        ::Cell::Rails.render_cell_collection_for(name, state, controller, *args, &block)
+      end
+    end
+  end
+end

data/lib/cells-collection/version.rb

@@ -0,0 +1,5 @@
+module Cells
+  module Collection
+    VERSION = '0.0.1'
+  end
+end

data/spec/cells/rails_spec.rb

@@ -0,0 +1,12 @@
+require 'cells/rails'
+require 'cells-collection/cells/rails'
+
+describe Cells::Rails::ActionView do
+  describe '#render_cell_collection' do
+    subject{ Object.new.extend(Cells::Rails::ActionView) }
+    it 'calls render_cell_collection_for' do
+      ::Cell::Rails.should_receive(:render_cell_collection)
+      subject.render_cell_collection
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: cells-collection
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- GoodLife
+- lulalala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cells
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Cells rendering for a collection of items, utilizing cache bulk-read.
+email:
+- mark@goodlife.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cells-collection.gemspec
+- lib/cells-collection.rb
+- lib/cells-collection/cell/caching.rb
+- lib/cells-collection/cell/rendering.rb
+- lib/cells-collection/cells/rails.rb
+- lib/cells-collection/version.rb
+- spec/cells/rails_spec.rb
+homepage: https://github.com/GoodLife/cells-collection
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Cells rendering for a collection of items
+test_files:
+- spec/cells/rails_spec.rb
+has_rdoc: