cached_names 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@gems

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    bbcoder (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rr (1.0.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bbcoder!
+  rr
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 John "asceth" Long, Jason Dew
+
+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,3 @@
+Features
+--------
+

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require "rspec/core/rake_task"
+
+Rspec::Core::RakeTask.new(:spec)
+
+gemspec = eval(File.read(File.join(Dir.pwd, "cached_names.gemspec")))
+
+task :build => "#{gemspec.full_name}.gem"
+
+task :test => :spec
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["cached_names.gemspec"] do
+  system "gem build cached_names.gemspec"
+  system "gem install cached_names-#{CachedNames::VERSION}.gem"
+end
+

data/cached_names.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "cached_names/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cached_names"
+  s.version     = CachedNames::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John 'asceth' Long", "Jason Dew"]
+  s.email       = ["jasondew@gmail.com", "machinist@asceth.com"]
+  s.homepage    = "http://github.com/asceth/cached_names"
+  s.summary     = "Cached names of static data for use in selects"
+  s.description = "A gem for caching static data for use in selects"
+
+  s.rubyforge_project = "cached_names"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rr'
+end
+

data/lib/cached_names/base.rb

@@ -0,0 +1,113 @@
+class CachedNames
+
+  def has_cached_names name_method = "value", options = {}
+    @cached_names_name_method = name_method
+    @cached_names_sort_field = options[:sorted_by] || @cached_names_name_method
+    @cached_names_group_method = options[:grouped_by]
+    @cached_names_cache_key_prefix = "cached_names_#{self}"
+    @cached_names_loaded = false
+
+    after_save { self.load_cached_names }
+    after_destroy { self.load_cached_names }
+
+    load_cached_names
+  end
+
+  def names
+    load_cached_names unless @cached_names_loaded
+
+    begin
+      Rails.cache.read "#{@cached_names_cache_key_prefix}_names"
+    rescue
+      load_cached_names
+      Rails.cache.read "#{@cached_names_cache_key_prefix}_names"
+    end
+  end
+
+  def names_with_deleted
+    load_cached_names unless @cached_names_loaded
+
+    begin
+      Rails.cache.read "#{@cached_names_cache_key_prefix}_names_with_deleted"
+    rescue
+      load_cached_names
+      Rails.cache.read "#{@cached_names_cache_key_prefix}_names_with_deleted"
+    end
+  end
+
+  def names_group key
+    load_cached_names unless @cached_names_loaded
+
+    begin
+      Rails.cache.read "#{@cached_names_cache_key_prefix}_names_group_#{key}"
+    rescue
+      load_cached_names
+      Rails.cache.read "#{@cached_names_cache_key_prefix}_names_group_#{key}"
+    end
+  end
+
+  def names_group_with_deleted key
+    load_cached_names unless @cached_names_loaded
+
+    begin
+      Rails.cache.read "#{@cached_names_cache_key_prefix}_names_group_#{key}_with_deleted"
+    rescue
+      load_cached_names
+      Rails.cache.read "#{@cached_names_cache_key_prefix}_names_group_#{key}_with_deleted"
+    end
+  end
+
+  def load_cached_names
+    begin
+      @cached_names_instances = all(:with_deleted => true, :order => @cached_names_sort_field)
+
+      load_names
+      load_grouped_names if @cached_names_group_method
+
+      @cached_names_loaded = true
+    rescue Exception => e
+      Rails.logger.error e.message
+      Rails.logger.error e.backtrace
+      @cached_names_loaded = false
+    end
+  end
+
+  private
+
+  def load_names
+    names = @cached_names_instances.map {|i| [i.deleted?, [i.send(@cached_names_name_method), i.id]] }
+    all_names, non_deleted_names = partition_by_deleted names
+
+    Rails.cache.write "#{@cached_names_cache_key_prefix}_names_with_deleted", all_names
+    Rails.cache.write "#{@cached_names_cache_key_prefix}_names", non_deleted_names
+  end
+
+  def load_grouped_names
+    groups = @cached_names_instances.inject({}) do |groups, instance|
+      value = instance.send(@cached_names_group_method)
+
+      groups[value] ||= []
+      groups[value] << [instance.deleted?, [instance.send(@cached_names_name_method), instance.id]]
+
+      groups
+    end
+
+    # when the value is nil, this means it is universal to all groups
+    universal_names = groups[nil] || []
+
+    groups.each do |(key, names)|
+      all_names, non_deleted_names = partition_by_deleted(names + universal_names)
+
+      Rails.cache.write "#{@cached_names_cache_key_prefix}_names_group_#{key}_with_deleted", all_names
+      Rails.cache.write "#{@cached_names_cache_key_prefix}_names_group_#{key}", non_deleted_names
+    end
+  end
+
+  def partition_by_deleted names
+    all_names = names.map {|(deleted, name_id_pair)| name_id_pair }
+    non_deleted_names = names.map {|(deleted, name_id_pair)| name_id_pair unless deleted }.compact
+
+    [all_names, non_deleted_names]
+  end
+end
+

data/lib/cached_names/version.rb

@@ -0,0 +1,3 @@
+class CachedNames
+  VERSION = "0.1.0"
+end

data/lib/cached_names.rb

@@ -0,0 +1,2 @@
+require 'cached_names/base'
+require "rails/cached_names" if defined?(Rails)

data/lib/rails/cached_names.rb

@@ -0,0 +1,7 @@
+module CachedNames
+  class Railtie < Rails::Railtie
+    initializer "cached_names.initialize" do |app|
+      ActiveRecord::Base.send :extend, CachedNames if defined?(ActiveRecord)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rspec'
+require 'cached_names'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: cached_names
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John 'asceth' Long
+- Jason Dew
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A gem for caching static data for use in selects
+email: 
+- jasondew@gmail.com
+- machinist@asceth.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gemtest
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- cached_names.gemspec
+- lib/cached_names.rb
+- lib/cached_names/base.rb
+- lib/cached_names/version.rb
+- lib/rails/cached_names.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/asceth/cached_names
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: cached_names
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Cached names of static data for use in selects
+test_files: []
+