bkerley-have-code 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bryce Kerley
+
+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.rdoc

@@ -0,0 +1,23 @@
+= have-code
+
+Add clever little base36 codes for your DataMapper and ActiveRecord objects.
+
+== Whoa seriously??
+
+   # ActiveRecord
+   initech = Mug.create :name=>'initech', :material=>'porcelain'
+   code = initech.code
+   initech == Mug.find_by_code code
+   
+   # DataMapper
+   kohg = Goblet.create :name=>'king of hyrule', :material=>'gold'
+   code = kohg.code
+   kohg == Goblet.find_by_code code
+
+== Dependencies
+
+* bkerley-affine (waiting on rubyforge to approve)
+
+== Copyright
+
+Copyright (c) 2009 Bryce Kerley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "have-code"
+    gem.summary = %Q{TODO}
+    gem.email = "bkerley@brycekerley.net"
+    gem.homepage = "http://github.com/bkerley/have-code"
+    gem.authors = ["Bryce Kerley"]
+
+    gem.add_dependency 'bkerley-affine'
+
+    gem.rubyforge_project = 'have-code'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "have-code #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 1

data/lib/have-code.rb

@@ -0,0 +1,21 @@
+require 'affine'
+require File.join(File.dirname(__FILE__), 'have-code', 'ar_code')
+require File.join(File.dirname(__FILE__), 'have-code', 'dm_code')
+module HaveCode
+  def self.enable_activerecord
+    return if ActiveRecord::Base.respond_to? :have_code
+    ActiveRecord::Base.send :include, ARCode
+  end
+  def self.enable_datamapper
+    return if DataMapper::Resource.respond_to? :have_code
+    DataMapper::Resource.send :include, DMCode
+  end
+end
+
+if defined? ActiveRecord::Base
+  HaveCode.enable_activerecord
+end
+
+if defined? DataMapper::Resource
+  HaveCode.enable_datamapper
+end

data/lib/have-code/ar_code.rb

@@ -0,0 +1,39 @@
+module HaveCode
+  module ARCode
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def have_code(mod, a, b)
+        write_inheritable_attribute :have_code_cipher, Affine::Cipher.new(mod, a, b)
+
+        extend OptionalClassMethods
+        include InstanceMethods
+      end
+    end
+
+    module OptionalClassMethods
+      def find_by_code(code)
+        return nil unless code.is_a? String
+        cipher = read_inheritable_attribute(:have_code_cipher)
+        candidate_id = cipher.decipher code.to_i(36)
+        object = self.find candidate_id
+        return object if object.code == code
+        return nil
+      rescue
+        nil
+      end
+    end
+
+    module InstanceMethods
+      def have_code_cipher
+        self.class.read_inheritable_attribute :have_code_cipher
+      end
+
+      def code
+        have_code_cipher.encipher(id).to_s(36)
+      end
+    end
+  end
+end

data/lib/have-code/dm_code.rb

@@ -0,0 +1,39 @@
+module HaveCode
+  module DMCode
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def have_code(mod, a, b)
+        write_inheritable_attribute :have_code_cipher, Affine::Cipher.new(mod, a, b)
+
+        extend OptionalClassMethods
+        include InstanceMethods
+      end
+    end
+
+    module OptionalClassMethods
+      def find_by_code(code)
+        return nil unless code.is_a? String
+        cipher = read_inheritable_attribute(:have_code_cipher)
+        candidate_id = cipher.decipher code.to_i(36)
+        object = self.get candidate_id
+        return object if object.code == code
+        return nil
+      rescue
+        nil
+      end
+    end
+
+    module InstanceMethods
+      def have_code_cipher
+        self.class.read_inheritable_attribute :have_code_cipher
+      end
+
+      def code
+        have_code_cipher.encipher(id).to_s(36)
+      end
+    end
+  end
+end

data/test/active_record_helper.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+HaveCode.enable_activerecord
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Base.connection.create_table :mugs do |t|
+  t.column :name, :string
+  t.column :material, :string
+end
+class Mug < ActiveRecord::Base
+end

data/test/data_mapper_helper.rb

@@ -0,0 +1,10 @@
+require 'datamapper'
+HaveCode.enable_datamapper
+DataMapper.setup(:default, 'sqlite3::memory:')
+class Goblet
+  include DataMapper::Resource
+  property :id, Serial
+  property :name, String
+  property :material, String
+end
+DataMapper.auto_upgrade!

data/test/have_code_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class HaveCodeTest < Test::Unit::TestCase
+  in_activerecord do
+    should "have a 'have_code' method" do
+      assert Mug.respond_to?(:have_code)
+    end
+    context "when configured with a code" do
+      setup do
+        Mug.have_code(60466169, 12034710206, 81268112)
+      end
+      should "have a 'find_by_code' method" do
+        assert Mug.respond_to?(:find_by_code)
+      end
+      should 'create an object, get its code, and recall it by code' do
+        initech = Mug.create :name=>'initech', :material=>'porcelain'
+        code = initech.code
+        assert code.is_a?(String)
+        lumbergh = Mug.find_by_code code
+        assert_equal initech, lumbergh
+      end
+    end
+  end
+  in_datamapper do
+    should "have a 'have_code' method" do
+      assert Goblet.respond_to?(:have_code)
+    end
+    context 'when configured with a code' do
+      setup do
+        Goblet.have_code(60466169, 12034710206, 81268112)
+      end
+      should "have a 'find_by_code' method" do
+        assert Goblet.respond_to?(:find_by_code)
+      end
+      should 'create an object, get its code, and recall it by code' do
+        kohg = Goblet.create :name=>'king of hyrule', :material=>'gold'
+        code = kohg.code
+        assert code.is_a?(String)
+        zelda = Goblet.find_by_code code
+        assert_equal kohg, zelda
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'have-code'
+
+class Test::Unit::TestCase
+  def self.in_activerecord(&block)
+    require 'active_record_helper'
+    context "Mug, an ActiveRecord class,", &block
+  end
+  def self.in_datamapper(&block)
+    require 'data_mapper_helper'
+    context "Goblet, a DataMapper class,", &block
+  end
+end
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: bkerley-have-code
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Bryce Kerley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bkerley-affine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: bkerley@brycekerley.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/have-code.rb
+- lib/have-code/ar_code.rb
+- lib/have-code/dm_code.rb
+- test/active_record_helper.rb
+- test/data_mapper_helper.rb
+- test/have_code_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bkerley/have-code
+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: have-code
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/active_record_helper.rb
+- test/data_mapper_helper.rb
+- test/have_code_test.rb
+- test/test_helper.rb