has_named_bootstraps 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.swp
+has_named_bootstraps_test.db
+rdoc
+has_named_bootstraps.gemspec
+pkg

data/COPYRIGHT

@@ -0,0 +1,14 @@
+Copyright (C) 2010, Children's Hospital Boston
+
+This library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/LGPL-V3-LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,39 @@
+= HasNamedBootstraps
+
+*This is alpha code.  The API is subject (and almost certain) to change.  It shouldn't hurt your computer or data, but if it does, I am not obligated to do anything, even feel sorry for you.*
+
+has_named_bootstraps is a simple way to load bootstrapped records into class-level constants, and generate a list in another constant of all such bootstraps.  This is handy for generating <select>s and writing certain kinds of tests.
+
+Getting the bootstrapped data in beforehand is up to you.  I like seed_fu (http://github.com/mbleigh/seed-fu) for this.
+
+= Example
+
+    class Department < ActiveRecord::Base
+      has_named_bootstraps(
+        :VALID_DEPARTMENTS,    # name of the constant that'll hold the list of all bootstrap constants
+        :R_AND_D         => 'R&D',
+        :MARKETING       => 'Marketing', 
+        :HANDSOME_DEVILS => 'Web Development' 
+      )
+    end
+
+    >> Department.find(:all)
+    => [#<Department id: 1, name: "R&D">, #<Department id: 2, name: "Marketing">, #<Department id: 3, name: "Web Development">]
+    >> Department::R_AND_D
+    => #<Department id: 1, name: "R&D">
+    >> Department::MARKETING
+    => #<Department id: 2, name: "Marketing">
+    >> Department::HANDSOME_DEVILS
+    => #<Department id: 3, name: "Web Development">
+    >> Department::VALID_DEPARTMENTS
+    => [#<Department id: 1, name: "R&D">, #<Department id: 2, name: "Marketing">, #<Department id: 3, name: "Web Development">]
+
+= TODO
+
+  -make master constant list optional
+  -allow caller to specify an attribute to use to find record (currently hardcoded to "name")
+  -write tests for shoulda macros, document same
+
+= License and copyright
+
+Copyright (c) 2010 Children's Hospital Boston, released under the GNU Lesser General Public License.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "has_named_bootstraps"
+    gem.summary = %Q{Load boostrapped database records into constants}
+    gem.description = %Q{has_named_bootstraps is a simple way to load bootstrapped records into class-level constants, and generate a list in another constant of all such bootstraps.  This is handy for generating <select>s and writing certain kinds of tests.}
+    gem.email = "philip.darnowsky@childrens.harvard.edu"
+    gem.homepage = "http://github.com/chb/has_named_bootstraps"
+    gem.authors = ["Phil Darnowsky"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has_named_bootstraps #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/has_named_bootstraps.rb

@@ -0,0 +1,32 @@
+module HasNamedBootstraps
+  def self.included(other)
+    other.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    # For each key/value pair in constant_hash, look up the record with the value in the "name" attribute, and assign it to the constant denoted by the key.  Assign a list of all such created constants to the constant named by valid_list_name.
+    #
+    # Example:
+    #
+    #   class Department < ActiveRecord::Base
+    #     has_named_bootstraps(
+    #       :VALID_DEPARTMENTS,    
+    #       :R_AND_D         => 'R&D',
+    #       :MARKETING       => 'Marketing', 
+    #       :HANDSOME_DEVILS => 'Web Development' 
+    #     )
+    #   end
+    #
+    # Department::R_AND_D, Department::MARKETING and Department::HANDSOME_DEVILS are now all defined and point to an ActiveRecord object.  Deparment::VALID_DEPARTMENTS is a list of those constants.
+
+    def has_named_bootstraps(valid_list_name, constant_hash)
+      valid_list = []
+
+      constant_hash.each do |constant_name, record_name|
+        valid_list << self.const_set(constant_name, self.find_by_name(record_name).freeze)
+      end
+
+      self.const_set(valid_list_name, valid_list.freeze)
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.send(:include, HasNamedBootstraps)

data/shoulda_macros/has_named_boostrap_macros.rb

@@ -0,0 +1,15 @@
+class ActiveSupport::TestCase
+  def self.should_have_bootstraps(klass, expected_bootstraps)
+    context '' do
+      should "have the correct bootstrapped values" do
+
+        expected_bootstraps.each do |expected_bootstrap|
+          assert klass.const_get(expected_bootstrap), "Constant #{klass.to_s}::#{expected_bootstrap.to_s} not set"
+        end
+
+        assert_equal expected_bootstraps.length, klass.count, "Extraneous bootstrap values in #{klass.to_s}"
+      end
+    end
+  end
+end
+

data/test/test_has_named_bootstraps.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class HasNamedBootstrapsTest < ActiveSupport::TestCase
+  CONSTANT_HASH = {
+    :R_AND_D         => 'R&D',
+    :MARKETING       => 'Marketing', 
+    :HANDSOME_DEVILS => 'Web Development' 
+  }
+
+  setup do
+    CONSTANT_HASH.values.each do |department_name|
+      Department.create!(:name => department_name)
+    end
+
+    Department.class_eval do
+      include HasNamedBootstraps
+
+      # Ignore "already initialized constant WHATEVER" warnings that we
+      # would otherwise get due to load_named_bootstraps running before every
+      # test, redefining constants as we go (which we want in this case)
+     
+      old_verbose = $VERBOSE
+      $VERBOSE = nil
+      has_named_bootstraps(
+        :VALID_DEPARTMENTS,
+        CONSTANT_HASH
+      )
+      $VERBOSE = old_verbose
+    end
+  end
+
+  context "#has_named_bootstraps" do
+    should "create each expected constant" do
+      CONSTANT_HASH.each do |constant_name, department_name|
+        bootstrapped_constant = Department.const_get(constant_name)
+        assert_equal department_name, bootstrapped_constant.name
+      end
+    end
+
+    should "add each expected constant to the list of valid constants" do
+      expected_object_ids = CONSTANT_HASH.keys.map{|hash_symbol| Department.const_get(hash_symbol)}.map(&:id)
+      actual_object_ids = Department::VALID_DEPARTMENTS.map(&:id)
+
+      assert_same_elements expected_object_ids, actual_object_ids
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'active_record/fixtures'
+require 'shoulda'
+require 'ruby-debug'
+
+require 'lib/has_named_bootstraps'
+
+ActiveRecord::Base.establish_connection(
+  :adapter   => 'sqlite3',
+  :database  => 'has_named_bootstraps_test.db'
+)
+
+ActiveRecord::Schema.define do
+  create_table 'departments', :force => true do |t|
+    t.column 'name', :string
+  end
+end
+
+class Department < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: has_named_bootstraps
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Phil Darnowsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: has_named_bootstraps is a simple way to load bootstrapped records into class-level constants, and generate a list in another constant of all such bootstraps.  This is handy for generating <select>s and writing certain kinds of tests.
+email: philip.darnowsky@childrens.harvard.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- COPYRIGHT
+- LGPL-V3-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/has_named_bootstraps.rb
+- rails/init.rb
+- shoulda_macros/has_named_boostrap_macros.rb
+- test/test_has_named_bootstraps.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/chb/has_named_bootstraps
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Load boostrapped database records into constants
+test_files: 
+- test/test_helper.rb
+- test/test_has_named_bootstraps.rb