encoder 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*~
+*.gem
+tmp
+.yardoc
+doc/*

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jon Morton
+
+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

@@ -0,0 +1,44 @@
+Encode
+=========
+
+Encode makes it easy to go from codes to meaningful strings.
+
+Example
+=======
+
+Suppose you have a task in one of three possible states: pending, active, finished.  When you store tasks, you'd like to have the state represented as P for pending, A for active, and F, for finished.  However, you don't want to worry about the details of turning a state into a specific character.
+
+t = Task.new('feed the cat')
+
+# By default 
+t.status = Status::Pending
+t.status         # => 'P'
+t.status.decode  # => 'Pending'
+
+# You'd probably encapsulate this in a method though wouldn't you?
+t.finish!
+
+# How should that be implemented though?
+@status = 'f'
+@status = 'finished'
+@status = Task::Status::Finished
+
+However, you want to store the state as a single character behind the scenes without having to define a bunch of custom getters or setters. 
+
+class Task
+	code :status do
+	  Status::Pending = "P" 
+	  Status::Active = "A"
+	  Status::Finished = "F"
+	end
+end
+
+To Do
+=====
+
+[ ] Auto-mixin on init
+[ ] Make a proper gem
+[ ] Choose a better name
+[ ] Use shoulda or rspec (maybe)
+
+Copyright (c) 2010 Jon Morton, released under the MIT license

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the encode plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the encode plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Encode'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "encoder"
+    gemspec.summary = "Make magic numbers and letters meaningful."
+    gemspec.description = "Simplify turning abbreviations into descriptions and vice versa."
+    gemspec.email = "jon.morton@gmail.com "
+    gemspec.homepage = "http://github.com/jmorton/encoder"
+    gemspec.authors = ["Jon Morton"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/encoder.rb

@@ -0,0 +1,92 @@
+module Encoder
+  
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+    end
+  end
+  
+  module ClassMethods
+  
+    #
+    # Creates getter and setter methods for an attribute.  The getter
+    # returns a 'decodable' string that provides more meaning.
+    #
+    # Example:
+    #
+    # class Task
+    #   include Encoder
+    #   code :priority do
+    #     Priority::Low = "L"
+    #   end
+    # end
+    #
+    # t = Task.new
+    # t.priority = Priority::Low
+    # t.priority                   # => "L"
+    # t.priority.decode            # => "Low"
+    #
+    def code(attribute_name, &block)
+      
+      # Create a 'namespace' for constants 
+      const_set(attribute_name.to_s.camelcase, Module.new)
+      
+      # Expecting constants to be assigned values.
+      yield
+      
+      # create setter for attribute
+      self.send(:define_method, "#{attribute_name}=") do |arg|
+        
+        # At the end of this method, the underlying attribute will be set
+        # to the value of this variable.
+        encoded_value = nil
+        
+        # Retrieve the module where the constants for this attribute are defined.
+        namespace = self.class.const_get(attribute_name.to_s.camelcase)
+        
+        # Since the given value might not match the constant name exactly
+        # (because of case sensitivity or white space variations) we
+        # normalize it a bit.
+        normalized = arg && arg.gsub(/\s+/,'').downcase
+        
+        # Now we look for a constant whose name or actual value match the
+        # normalized argument.  We 'tap' whatever constant name is found
+        # and lookup the actual value.
+        namespace.constants.find do |const_name|
+          normalized == const_name.downcase ||
+          normalized == namespace.const_get(const_name).downcase
+        end.tap do |match|
+          encoded_value = namespace.const_get(match) if match
+        end
+        
+        # Set the value to whatever we found, possibly nil
+        self.write_attribute(attribute_name, encoded_value)
+      end
+  
+      # create getter for attribute
+      self.send(:define_method, attribute_name) do
+      
+        encoded_attribute = self.read_attribute(attribute_name)
+        
+        namespace = self.class.const_get(attribute_name.to_s.camelcase)
+      
+        decoded_value = namespace.constants.select do |constant|
+          namespace.const_get(constant) == encoded_attribute
+        end.first
+      
+        encoded_attribute.instance_variable_set(:@decoding, decoded_value)
+      
+        class << encoded_attribute
+          def decode
+            @decoding && @decoding.underscore.titleize
+          end
+        end
+      
+        return encoded_attribute
+      end # -- dynamic getter method 
+        
+    end # -- code()
+    
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), *%w[.. lib encoder])

data/tasks/encoder_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :encoder do
+#   # Task goes here
+# end

data/test/database.rb

@@ -0,0 +1,36 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'active_record'
+gem 'sqlite3-ruby'
+
+require File.dirname(__FILE__) + '/../rails/init'
+  
+ActiveRecord::Base.logger = Logger.new('/tmp/encoder.log')
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => '/tmp/encoder.sqlite')
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.default_timezone = :utc if Time.zone.nil?
+
+ActiveRecord::Schema.define do
+  create_table :tasks, :force => true do |table|
+    table.string :status
+    table.string :priority
+  end
+end
+
+class Task < ActiveRecord::Base
+  include ::Encoder
+  
+	code :status do
+	  Status::New      = "N"
+	  Status::Pending  = "P"
+	  Status::Finished = "F"
+	  Status::OverDue  = "O"
+	end
+	
+	code :priority do
+	  Priority::High =  "H"
+	  Priority::Low =   "L"
+  end
+	
+end

data/test/functional/encoder_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../test_helper'))
+
+class EncoderTest < ActiveSupport::TestCase
+  
+  test "setting an attribute using a constant persists the encoding" do
+    task = ::Task.new
+    task.status = Task::Status::New
+    task.save
+    
+    db_task = ::Task.first
+    assert db_task.status == 'N'
+  end
+
+  test "setting an attribute using a description persists the correct encoding" do
+    task = ::Task.new
+    task.status = 'New'
+    task.save
+    
+    db_task = ::Task.first
+    assert db_task.status == 'N'
+    assert db_task.status.decode == 'New'
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'test/unit'
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/encoder'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'database'))

data/test/unit/encoder_test.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../test_helper'))
+
+class EncoderTest < ActiveSupport::TestCase
+  
+  test "setting an attribute using a constant" do
+    task = ::Task.new
+    task.status = Task::Status::New
+    assert task.status == Task::Status::New
+  end
+  
+  test "setting an attribute using a verbose value" do
+    task = ::Task.new
+    task.status = "New"
+    assert task.status == Task::Status::New
+  end
+  
+  test "setting an attribute using a an invalid value overwrites a valid one" do
+    task = ::Task.new
+    task.status = "New"
+    task.status = "Invalid"
+    assert task.status == nil
+  end
+  
+  test "decoding an attribute should match the constant name" do
+    task = ::Task.new
+    task.status = Task::Status::New
+    assert task.status.decode == 'New'
+  end
+  
+  test "encoding a description ignores caps" do
+    task = ::Task.new
+    task.status = 'new'
+    assert task.status == Task::Status::New
+    task.status = 'NEW'
+    assert task.status == Task::Status::New
+  end
+  
+  test "encoding a multiword description" do
+    task = ::Task.new
+    task.status = 'over due'
+    assert task.status == Task::Status::OverDue
+  end
+  
+  test "decoding a multiword description" do
+    task = ::Task.new
+    task.status = Task::Status::OverDue
+    assert task.status.decode == 'Over Due'
+  end
+  
+  test "setting an encoded attribute to nil" do
+    task = ::Task.new
+    task.status = nil
+    assert task.status == nil
+  end
+  
+  test "a code's attribute name corresponds to a camelcased namespace" do
+    task = ::Task.new
+    
+    class ::Task
+      code :foo_bar do
+        FooBar::Baz = 1
+        FooBar::Buzz = 2
+      end
+    end
+    
+    assert Task.const_defined?(:FooBar)
+  end
+  
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: encoder
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jon Morton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-20 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Simplify turning abbreviations into descriptions and vice versa.
+email: "jon.morton@gmail.com "
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- install.rb
+- lib/encoder.rb
+- rails/init.rb
+- tasks/encoder_tasks.rake
+- test/database.rb
+- test/functional/encoder_test.rb
+- test/test_helper.rb
+- test/unit/encoder_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/jmorton/encoder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Make magic numbers and letters meaningful.
+test_files: 
+- test/database.rb
+- test/functional/encoder_test.rb
+- test/test_helper.rb
+- test/unit/encoder_test.rb