in_memory_enumeration 0.2.0

data/README.markdown

@@ -0,0 +1,55 @@
+## In Memory Enumeration
+Provide a similar API to [`acts_as_enumerable`](https://github.com/pivotal/enumerations_mixin) but in memory instead of database tables.
+
+## Installation
+Install `in_memory_enumeration` as a gem.
+
+## Usage
+Create a class which extends Pivotal::InMemoryEnumeration and configure your enums like such: 
+
+     class Enums < Pivotal::InMemoryEnumeration
+       Enums.enumerated_values = [
+           Enums.new(1, "One"),
+           Enums.new(2, "Two"),
+         ]
+     end
+
+## Requirements
+To initialize properly, this gem requires Rails 3.0 or above.
+
+## Running Tests and Build Dependencies
+Below is a sample Gemfile used to create and test this gem.
+
+     # Gemfile
+     source "http://rubygems.org"
+     
+     gem "rails", "3.0.3"
+     gem "sqlite3-ruby", "1.3.2"
+     gem "rspec-rails", "2.1.0"
+     gem "jeweler", "1.5.1"
+
+## MIT License
+
+Copyright (c) 2010 Pivotal Labs (www.pivotallabs.com)
+Contact email: amilligan@pivotallabs.com
+
+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/lib/in_memory_enumeration/in_memory_enumeration.rb

@@ -0,0 +1,52 @@
+module Pivotal
+
+  # Provide a similar API to acts_as_enumerable but in memory instead of database tables
+  class InMemoryEnumeration
+    def initialize(id, name)
+      @id = id
+      @name = name
+    end
+
+    attr_reader :id, :name
+    class_inheritable_accessor :enumerated_values
+
+    def quoted_id
+      id
+    end
+
+    def to_param
+      id.to_s
+    end
+
+    def self.all
+      enumerated_values
+    end
+
+    def self.count
+      enumerated_values.size
+    end
+
+    def self.[](arg)
+      case arg
+      when Symbol
+        rval = lookup_name(arg.id2name) and return rval
+      when String
+        rval = lookup_name(arg) and return rval
+      when Fixnum
+        rval = lookup_id(arg) and return rval
+      when nil
+        rval = nil
+      else
+        raise TypeError, "#{self.name}[]: argument should be a String, Symbol or Fixnum but got a: #{arg.class.name}"
+      end
+    end
+
+    def self.lookup_name(name)
+      enumerated_values.detect {|status| status.name == name}
+    end
+
+    def self.lookup_id(id)
+      enumerated_values.detect {|status| status.id == id}
+    end
+  end
+end

data/lib/in_memory_enumeration.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require 'in_memory_enumeration/in_memory_enumeration'
+
+module Pivotal
+  class InMemoryEnumeration
+    class Railtie < ::Rails::Engine
+      config.autoload_paths << File.expand_path(File.join(File.dirname(__FILE__), 'in_memory_enumeration'))
+    end
+  end
+end

data/spec/in_memory_enumeration_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe Pivotal::InMemoryEnumeration do  
+  class Ime < Pivotal::InMemoryEnumeration 
+    self.enumerated_values = [
+      Ime.new(1, "One"),
+      Ime.new(2, "Two"),
+      Ime.new(3, "Three")
+      ]
+  end
+  
+  describe 'new' do 
+    it "can find by id" do 
+      ime = Ime[1]
+      ime.id.should == 1
+      ime.name.should =="One"
+    end
+
+    it "can find by string name" do 
+      ime = Ime['One']
+      ime.id.should == 1
+      ime.name.should =="One"
+    end
+    
+    it "can find by symbol name" do 
+      ime = Ime[:One]
+      ime.id.should == 1
+      ime.name.should =="One"
+    end
+    
+    it "return nil for nil" do 
+      Ime[nil].should be_nil
+    end
+     
+    it "will raise if key is worng type" do 
+      lambda{Ime[/bad/]}.should raise_error
+    end
+  end
+  
+  describe "ids" do 
+    it "should use id from quoted_id" do 
+      Ime[1].quoted_id.should == 1
+    end
+    
+    it "should use id for param" do 
+      Ime[1].to_param.should == "1"     
+    end
+  end
+  
+  describe "totals" do 
+    
+    it "should have count" do 
+      Ime.count.should == 3
+    end
+    
+    it "should have them all" do 
+      Ime.all.should == Ime.enumerated_values
+    end
+  end
+  
+  describe "lookups" do 
+    it "can look up by id" do 
+      Ime.lookup_id(1).name.should == "One"
+    end
+    
+    it "can look up by name" do 
+      Ime.lookup_name("One").id.should == 1
+    end
+  end
+end

data/spec/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/rails_app/config/application.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+require File.expand_path(File.join(__FILE__, '../../../../lib/in_memory_enumeration'))
+
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module RailsApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/rails_app/config/boot.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../../Gemfile', __FILE__)
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end if File.exist?(gemfile)

data/spec/rails_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+RailsApp::Application.initialize!

data/spec/rails_app/config/environments/development.rb

@@ -0,0 +1,26 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/spec/rails_app/config/environments/production.rb

@@ -0,0 +1,49 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/spec/rails_app/config/environments/test.rb

@@ -0,0 +1,35 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/rails_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/rails_app/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/rails_app/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/rails_app/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+RailsApp::Application.config.secret_token = '3857cde0b808b14a568e82ae11f2b261560e250e9e99cb9c9d6d385ee99af5819b74a81e1f3028fd2831ed6094a31c5dead5e6146a310d3e1b75960006d960a4'

data/spec/rails_app/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+RailsApp::Application.config.session_store :cookie_store, :key => '_rails_app_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# RailsApp::Application.config.session_store :active_record_store

data/spec/rails_app/config/routes.rb

@@ -0,0 +1,58 @@
+RailsApp::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => "welcome#index"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/spec/rails_app/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Daley', :city => cities.first)

data/spec/rails_app/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/spec/rails_app/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+ENV["RAILS_ENV"] ||= "test"
+require 'rails_app/config/environment'
+require "rspec/rails"
+
+#Spec::Example::ExampleGroupFactory.register(:functional, Spec::Rails::Example::FunctionalExampleGroup)
+#Spec::Runner.configure do |configuration|
+#  configuration.include CommonTestHelper
+#  configuration.use_transactional_fixtures = true
+#  configuration.use_instantiated_fixtures  = false
+#  configuration.fixture_path = 'vendor/plugins/pivotal_core_bundle/spec/fixtures/'
+#  configuration.global_fixtures = :all
+#end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: in_memory_enumeration
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Pivotal Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-24 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Use in_memory_enumeration instead of hashes and statics for your enum data.
+email: pivotal-opensource@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- lib/in_memory_enumeration.rb
+- lib/in_memory_enumeration/in_memory_enumeration.rb
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/pivotal/in_memory_enumeration
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provide a similar API to acts_as_enumerable but in memory instead of database tables.
+test_files: 
+- spec/in_memory_enumeration_spec.rb
+- spec/rails_app/app/controllers/application_controller.rb
+- spec/rails_app/app/helpers/application_helper.rb
+- spec/rails_app/config/application.rb
+- spec/rails_app/config/boot.rb
+- spec/rails_app/config/environment.rb
+- spec/rails_app/config/environments/development.rb
+- spec/rails_app/config/environments/production.rb
+- spec/rails_app/config/environments/test.rb
+- spec/rails_app/config/initializers/backtrace_silencers.rb
+- spec/rails_app/config/initializers/inflections.rb
+- spec/rails_app/config/initializers/mime_types.rb
+- spec/rails_app/config/initializers/secret_token.rb
+- spec/rails_app/config/initializers/session_store.rb
+- spec/rails_app/config/routes.rb
+- spec/rails_app/db/seeds.rb
+- spec/rails_app/test/performance/browsing_test.rb
+- spec/rails_app/test/test_helper.rb
+- spec/spec_helper.rb