add_symbolic_names 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85d02ac625bf040cde94a04304cf764186b7b2cd
+  data.tar.gz: 935762f355537a2c8396a2506cba3f6b73b00413
+SHA512:
+  metadata.gz: 865059c39f2e856436730fb346cfb77b93679a2e77f8bdb06d6bd35e6202886919cd7388b35ffe71f4a6feff69013e74b74e819248ef3da4246619334fcb2ca0
+  data.tar.gz: 1cd9ac4be1f6d4596583b2a20ab90162ff48c9c8c4e42759692209042e8dd7843aff2fa8e54a4db582d88f82c2358a71dba7183c0b62aecf6b954c759711d6f3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,89 @@
+# AddSymbolicNames [![Build Status](https://travis-ci.org/avvo/add_symbolic_names.png?branch=master)](https://travis-ci.org/avvo/add_symbolic_names)
+
+ActiveRecord plugin for creating constants from a domain table
+
+## Motivation
+
+You have foreign keys in your database that are actually constants.
+
+## Usage
+
+In your Gemfile:
+
+```
+gem 'add_symbolic_names'
+```
+
+In your ActiveRecord model:
+
+```
+class SomeDomain < ActiveRecord::Base
+  add_symbolic_names
+end
+```
+
+## Configuration
+
+The `add_symbolic_names` method takes an options hash with 3 possible values:
+
+* `symbolic_name_attrib` - the name of the column/attribute to use when defining the constant name
+* `value_attrib` - the name of the column/attribute to use for the value of the constant
+* `store` - how to load the data
+
+## Stores
+
+There are 2 data stores available
+
+### ActiveRecord
+
+ActiveRecord is the default data store.  It loads all records, iterating through and defining constants with a name of the `symbolic_name_attrib` option with a value of the `value_attrib` option.
+
+```
+…
+add_symbolic_names store: :active_record, 
+                   symbolic_name_attrib: :some_column, 
+                   value_attrib: :another_column
+```
+
+### Yaml
+
+Yaml store loads from your db/domain folder a yaml file with the pluralized, demodulized class name. (User => users.yml)
+
+```
+…
+add_symbolic_names store: :yaml
+```
+
+## Example
+
+Let's say you keep track of how you create users on your site.  You have a `user_creation_methods` table that looks something like:
+
+| id | symbolic_name |
+|----|---------------|
+|  1 |         EMAIL |
+|  2 |      REGISTER |
+|  3 |        IMPORT |
+
+```
+class UserCreationMethod < ActiveRecord::Base
+  add_symbolic_names
+end
+```
+
+You now have access to some namespaced constants:
+
+* `UserCreationMethod::EMAIL` => 1
+* `UserCreationMethod::REGISTER` => 2
+* `UserCreationMethod::IMPORT` => 3
+
+```
+class User < ActiveRecord::Base
+  belongs_to :user_creation_method
+  
+  scope :imported, -> { where(user_creation_method_id: UserCreationMethod::IMPORT) }
+end
+```
+
+## Credit
+
+[bvandenbos](http://github.com/bvandenbos) actually wrote this 6+ years ago. We think this could be useful for others.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AddSymbolicNames'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/add_symbolic_names/mixin.rb

@@ -0,0 +1,15 @@
+module AddSymbolicNames
+  module Mixin
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      
+      def add_symbolic_names(opts = {})
+        store = Store.fetch(opts.fetch(:store) { AddSymbolicNames.default_store })
+
+        store.define_constants(self, opts)
+      end
+      
+    end
+  end  
+end

data/lib/add_symbolic_names/railtie.rb

@@ -0,0 +1,14 @@
+module AddSymbolicNames
+  class Railtie < ::Rails::Railtie
+    config.add_symbolic_names = ActiveSupport::OrderedOptions.new
+    config.add_symbolic_names.default_store = nil
+
+    initializer 'add_symbolic_names' do |app|
+      AddSymbolicNames.default_store = app.config.add_symbolic_names.default_store if app.config.add_symbolic_names.default_store
+      ActiveSupport.on_load(:active_record) do
+        include AddSymbolicNames::Mixin
+      end
+    end
+
+  end
+end

data/lib/add_symbolic_names/store/active_record.rb

@@ -0,0 +1,17 @@
+module AddSymbolicNames
+  module Store
+    class ActiveRecord
+      def self.define_constants(klass, opts)
+        symbolic_name_attr = opts.fetch(:symbolic_name_attrib, :symbolic_name)
+        value_attr = opts.fetch(:value_attrib, :id)
+
+        klass.all.each do |record|
+          symbolic_name = record.send(symbolic_name_attr)
+          value = record.send(value_attr)
+
+          klass.const_set(symbolic_name, value) unless klass.const_defined?(symbolic_name)
+        end
+      end
+    end
+  end
+end

data/lib/add_symbolic_names/store/yaml.rb

@@ -0,0 +1,13 @@
+require 'yaml'
+
+module AddSymbolicNames
+  module Store
+    class Yaml
+      def self.define_constants(klass, opts)
+        YAML.load_file(File.join(Rails.root, "db/domain/#{klass.name.demodulize.tableize}.yml")).each do |datum|
+          klass.const_set(datum['symbolic_name'], datum['id']) unless klass.const_defined?(datum['symbolic_name'])
+        end
+      end
+    end
+  end
+end

data/lib/add_symbolic_names/store.rb

@@ -0,0 +1,11 @@
+module AddSymbolicNames
+  module Store
+
+    autoload :ActiveRecord, 'add_symbolic_names/store/active_record'
+    autoload :Yaml, 'add_symbolic_names/store/yaml'
+
+    def self.fetch(type)
+      const_get(type.to_s.classify)
+    end
+  end
+end

data/lib/add_symbolic_names/version.rb

@@ -0,0 +1,3 @@
+module AddSymbolicNames
+  VERSION = "0.1.0"
+end

data/lib/add_symbolic_names.rb

@@ -0,0 +1,9 @@
+module AddSymbolicNames
+  mattr_accessor :default_store
+  self.default_store = :active_record
+
+  autoload :Mixin, 'add_symbolic_names/mixin'
+  autoload :Store, 'add_symbolic_names/store'
+end
+
+require 'add_symbolic_names/railtie' if defined? Rails

data/test/add_symbolic_names_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class AddSymbolicNamesTest < ActiveSupport::TestCase
+
+  test "loading from ActiveRecord" do
+    assert_equal 1, UserCreationMethod::EMAIL
+    assert_equal 2, UserCreationMethod::REGISTER
+    assert_equal 3, UserCreationMethod::IMPORT
+  end
+
+  test "loading alternate column names" do
+    assert_equal "Washington", State::WA
+    assert_equal "Oregon", State::OR
+    assert_equal "California", State::CA
+  end
+
+  test "loading from yaml" do
+    assert_equal 1, User::UNKNOWN
+    assert_equal 2, User::ADMIN
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: add_symbolic_names
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben VandenBos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: ActiveRecord plugin for creating constants from a domain table
+email: bvandenbos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/add_symbolic_names/mixin.rb
+- lib/add_symbolic_names/railtie.rb
+- lib/add_symbolic_names/store/active_record.rb
+- lib/add_symbolic_names/store/yaml.rb
+- lib/add_symbolic_names/store.rb
+- lib/add_symbolic_names/version.rb
+- lib/add_symbolic_names.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/add_symbolic_names_test.rb
+homepage: http://github.com/avvo/add_symbolic_names
+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.3
+signing_key: 
+specification_version: 4
+summary: ActiveRecord plugin for creating constants from a domain table
+test_files:
+- test/add_symbolic_names_test.rb