dm-is-checksumed 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "dm-is-checksumed Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2011-04-06
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,142 @@
+# If you're working on more than one datamapper gem at a time, then it's
+# recommended to create a local Gemfile and use this instead of the git
+# sources. This will make sure that you are  developing against your
+# other local datamapper sources that you currently work on. Gemfile.local
+# will behave identically to the standard Gemfile apart from the fact that
+# it fetches the datamapper gems from local paths. This means that you can
+# use the same environment variables, like ADAPTER(S) or PLUGIN(S) when
+# running
+# bundle commands. Gemfile.local is added to .gitignore, so you don't need
+# to worry about accidentally checking local development paths into git.
+# In order to create a local Gemfile, all you need to do is run:
+#
+#   bundle exec rake local_gemfile
+#
+# This will give you a Gemfile.local file that points to your local clones
+# of the various datamapper gems. It's assumed that all datamapper repo
+# clones reside in the same directory. You can use the Gemfile.local like
+# so for running any bundle command:
+#
+#   BUNDLE_GEMFILE=Gemfile.local bundle foo
+#
+# You can also specify which adapter(s) should be part of the bundle by
+# setting an environment variable. This of course also works when using the
+# Gemfile.local
+#
+#   bundle foo                        # dm-sqlite-adapter
+#
+#   ADAPTER=mysql bundle foo          # dm-mysql-adapter
+#
+#   ADAPTERS=sqlite,mysql bundle foo  # dm-sqlite-adapter, dm-mysql-adapter
+#
+# Of course you can also use the ADAPTER(S) variable when using the
+# Gemfile.local and running specs against selected adapters.
+#
+# For easily working with adapters supported on your machine, it's
+# recommended that you first install all adapters that you are planning to
+# use or work on by doing something like
+#
+#   ADAPTERS=sqlite,mysql,postgres bundle install
+#
+# This will clone the various repositories and make them available to
+# bundler. Once you have them installed you can easily switch between
+# adapters for the various development tasks. Running something like
+#
+#   ADAPTER=mysql bundle exec rake spec
+#
+# will make sure that the dm-mysql-adapter is part of the bundle, and will
+# be used when running the specs.
+#
+# You can also specify which plugin(s) should be part of the bundle by
+# setting an environment variable. This also works when using the
+# Gemfile.local
+#
+#   bundle foo                                 # dm-migrations
+#
+#   PLUGINS=dm-validations bundle foo          # dm-migrations,
+#                                              # dm-validations
+#
+#   PLUGINS=dm-validations,dm-types bundle foo # dm-migrations,
+#                                              # dm-validations,
+#                                              # dm-types
+#
+# Of course you can combine the PLUGIN(S) and ADAPTER(S) env vars to run
+# specs for certain adapter/plugin combinations.
+#
+# Finally, to speed up running specs and other tasks, it's recommended to
+# run
+#
+#   bundle lock
+#
+# after running 'bundle install' for the first time. This will make
+# 'bundle exec' run a lot faster compared to the unlocked version. With an
+# unlocked bundle you would typically just run 'bundle install' from time
+# to time to fetch the latest sources from upstream. When you locked your
+# bundle, you need to run
+#
+#   bundle install --relock
+#
+# to make sure to fetch the latest updates and then lock the bundle again.
+# Gemfile.lock is added to the .gitignore file, so you don't need to worry
+# about accidentally checking it into version control.
+
+source :rubygems
+
+DATAMAPPER = 'http://github.com/datamapper'
+DM_VERSION = '~> 1.0'
+DO_VERSION = '~> 0.10.2'
+DM_DO_ADAPTERS = %w[sqlite postgres mysql oracle sqlserver]
+RAILS = 'http://github.com/rails/rails.git'
+
+if ENV['EXTLIB']
+  gem 'extlib',         '~> 0.9.15', :git => "#{DATAMAPPER}/extlib.git",
+                                     :require => nil
+else
+  gem 'activesupport',  '~> 3.0.4', :require => nil
+  gem 'i18n',           '~> 0.5.0'
+end
+
+gem 'dm-core',	DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
+
+group :development do
+  gem 'rake',		    '~> 0.8.7'
+
+  gem 'ore-tasks',	'~> 0.4'
+  gem 'rspec',      '~> 2.4'
+
+  gem 'kramdown',   '~> 0.12.0'
+  gem 'yard',		    '~> 0.6.0'
+end
+
+group :datamapper do
+  # We need this because we want to pin these dependencies to their git
+  # master sources
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    options = {}
+    options[:git] = "#{DATAMAPPER}/do.git" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects',  DO_VERSION, options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, options.dup
+    end
+
+    gem 'dm-do-adapter', DM_VERSION, :git => "#{DATAMAPPER}/dm-do-adapter.git"
+  end
+
+  adapters.each do |adapter|
+    gem "dm-#{adapter}-adapter", DM_VERSION, :git => "#{DATAMAPPER}/dm-#{adapter}-adapter.git"
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('dm-migrations').uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION, :git => "#{DATAMAPPER}/#{plugin}.git"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Hal Brodigan
+
+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,71 @@
+# dm-is-checksumed
+
+* [Source](http://github.com/postmodern/dm-is-checksumed)
+* [Issues](http://github.com/postmodern/dm-is-checksumed/issues)
+* [Documentation](http://rubydoc.info/gems/dm-is-checksumed/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+A DataMapper plugin which adds checksum properties to a Model, referencing
+other properties.
+
+## Features
+
+* Uses sha256
+* Allows unique and non-unique checksums.
+* Automatically substitutes in checksums in queries to avoid expensive
+  queries.
+* Works with `first_or_create` and `first_or_new`.
+
+## Examples
+
+    require 'dm-is-checksumed'
+
+    class Url
+
+      include DataMapper::Resource
+
+      is :checksumed
+
+      property :id, Serial
+
+      # The property to be checksumed
+      property :url, Text
+
+      # Defines the `url_checksum` property, referencing `url`
+      checksum :url
+
+    end
+
+    # Checksums are automatically calculated
+    url = Url.create(:url => 'http://example.com/extremely/long/url....')
+    url.url_checksum
+    # => "b74d7288b86817dea55bd044d3cedc013e83518b461cd6f202be85e33d95715b"
+
+    # Checksums are automatically substituted into queries
+    url = Url.first(:url => 'http://example.com/same/huge/url')
+    # ~ (0.000116) SELECT "id", "url_checksum" FROM "urls" WHERE "url_checksum" = 'b74d7288b86817dea55bd044d3cedc013e83518b461cd6f202be85e33d95715b' ORDER BY "id" LIMIT 1
+
+    # Works with first_or_create and first_or_new
+    url = Url.first_or_create(:url => 'http://example.com/same/huge/url')
+    url.url_checksum
+    # => "b74d7288b86817dea55bd044d3cedc013e83518b461cd6f202be85e33d95715b"
+
+    url = Url.first_or_create(:url => 'http://example.com/different/url')
+    url.url_checksum
+    # => "09a27797a33153b005871b61675a920fa6bedbb034a3b283bbe5803a1d31ac42"
+
+## Requirements
+
+* [dm-core](http://github.com/datamapper/dm-core) ~> 1.0
+
+## Install
+
+    $ gem install dm-is-checksumed
+
+## Copyright
+
+Copyright (c) 2011 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'ore/tasks'
+Ore::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard
+

data/dm-is-checksumed.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The '#{__FILE__}' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
+end

data/gemspec.yml

@@ -0,0 +1,19 @@
+name: dm-is-checksumed
+version: 0.1.0
+summary: Adds checksum properties to DataMapper Models.
+description:
+  A DataMapper plugin which adds checksum properties to a Model,
+  referencing other properties.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/dm-is-checksumed
+has_yard: true
+
+dependencies:
+  dm-core: ~> 1.0
+
+development_dependencies:
+  yard: ~> 0.6.0
+  bundler: ~> 1.0.0

data/lib/dm-is-checksumed.rb

@@ -0,0 +1,4 @@
+require 'dm-core'
+require 'dm-is-checksumed/is/checksumed'
+
+DataMapper::Model.append_extensions DataMapper::Is::Checksumed

data/lib/dm-is-checksumed/is/checksumed.rb

@@ -0,0 +1,143 @@
+require 'dm-core'
+require 'digest/sha2'
+
+module DataMapper
+  module Is
+    module Checksumed
+      #
+      # Fired when your plugin gets included into a Model.
+      #
+      def is_checksumed(options={})
+        extend DataMapper::Is::Checksumed::ClassMethods
+      end
+
+      module ClassMethods
+        #
+        # The properties which have accompanying checksums.
+        #
+        # @return [Set<Symbol>]
+        #   The property names.
+        #
+        def checksumed_properties
+          @checksumed_properties ||= Set[]
+        end
+
+        #
+        # Determines if a checksum property was defined for another
+        # property.
+        #
+        # @param [Symbol, String] name
+        #   The name of the property.
+        #
+        # @return [Boolean]
+        #   Specifies whether the property has an checksum property.
+        #
+        def checksumed?(name)
+          checksumed_properties.include?(name.to_sym)
+        end
+
+        #
+        # Calculates the SHA256 checksum of the given data.
+        #
+        # @param [#to_s] data
+        #   The data to checksum.
+        #
+        # @return [String]
+        #   The SHA256 hex-digest of the data.
+        #
+        def calculate_checksum(data)
+          Digest::SHA256.hexdigest(data.to_s)
+        end
+
+        #
+        # Substitutes any checksumed properties with the checksums of their
+        # values.
+        #
+        # @param [DataMapper::Undefined, DataMapper::Query, Hash] query
+        #   The query.
+        #
+        # @return [DataMapper::Resource, nil]
+        #   The matching resource.
+        #
+        def first(query=Undefined)
+          super(checksum_query(query))
+        end
+
+        #
+        # Substitutes any checksumed properties with the checksums of their
+        # values.
+        #
+        # @param [DataMapper::Undefined, DataMapper::Query, Hash] query
+        #   The query.
+        #
+        # @return [DataMapper::Collection]
+        #   The matching resources.
+        #
+        def all(query=Undefined)
+          super(checksum_query(query))
+        end
+
+        #
+        # Filters a query, replacing the checksumed properties, with their
+        # accompanying checksums.
+        #
+        # @param [Hash, DataMapper::Undefined] query
+        #   The query to filter.
+        #
+        # @return [Hash, DataMapper::Undefined]
+        #   The filtered query.
+        #
+        def checksum_query(query)
+          return query unless query.kind_of?(Hash)
+
+          new_query = {}
+
+          query.each do |name,value|
+            if (name.respond_to?(:to_sym) && checksumed_properties.include?(name.to_sym))
+              new_query[:"#{name}_checksum"] = calculate_checksum(value)
+            else
+              new_query[name] = value
+            end
+          end
+
+          return new_query
+        end
+
+        protected
+
+        #
+        # Defines a checksum property for another property.
+        #
+        # @param [Symbol] name
+        #   The name of the property to checksum.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Boolean] :unique (true)
+        #   Specifies whether the checksums are to be unique, or if
+        #   duplicates are allowed.
+        #
+        def checksum(name,options={})
+          # build the checksum property options
+          property_options = {
+            :length => 64,
+            :required => true,
+            :default => lambda { |resource,property|
+              calculate_checksum(resource.attribute_get(name))
+            }
+          }
+
+          if options.fetch(:unique,true)
+            property_options[:unique] = true
+          else
+            property_options[:index] = true
+          end
+
+          property :"#{name}_checksum", String, property_options
+          checksumed_properties << name
+        end
+      end # ClassMethods
+    end # Checksumed
+  end # Is
+end # DataMapper

data/spec/integration/checksumed_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'models/url'
+
+describe DataMapper::Is::Checksumed do
+  subject { Url }
+
+  before(:all) { subject.auto_migrate! }
+
+  let(:url) { 'http://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA' }
+  let(:url_checksum) { '7aea54fe73fda6bca28f47ea57f1af1a6bc7b28ef323a3b85763131baad46e8e' }
+
+  it "should calculate the checksums of properties" do
+    resource = subject.new(:url => url)
+
+    resource.url_checksum.should == url_checksum
+  end
+
+  context "queries" do
+    before(:all) do
+      subject.create(:url => 'http://foo/')
+      subject.create(:url => url)
+      subject.create(:url => 'http://bar/')
+    end
+
+    it "should find the first resource with a matching checksum" do
+      resource = subject.first(:url => url)
+
+      resource.url_checksum.should == url_checksum
+      resource.url.should == url
+    end
+
+    it "should find all resources with a matching checksum" do
+      resources = subject.all(:url => url)
+
+      resources.length.should == 1
+      resources[0].url_checksum.should == url_checksum
+      resources[0].url.should == url
+    end
+  end
+end

data/spec/models/url.rb

@@ -0,0 +1,16 @@
+require 'dm-core'
+require 'dm-is-checksumed'
+
+class Url
+
+  include DataMapper::Resource
+
+  is :checksumed
+
+  property :id, Serial
+
+  property :url, Text, :required => true
+
+  checksum :url
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'dm-core/spec/setup'
+require 'dm-core/spec/lib/adapter_helpers'
+
+require 'dm-is-checksumed'
+
+DataMapper::Logger.new(STDERR, :debug) if ENV['DEBUG']
+DataMapper::Spec.setup
+
+RSpec.configure do |config|
+  config.extend(DataMapper::Spec::Adapters::Helpers)
+end

data/spec/unit/checksumed_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'models/url'
+
+describe DataMapper::Is::Checksumed do
+  subject { Url }
+
+  before(:all) { subject.auto_migrate! }
+
+  it "should record which properties are checksumed" do
+    subject.checksumed_properties.should include(:url)
+  end
+
+  it "should add accompanying checksum properties" do
+    subject.properties.should be_named(:url_checksum)
+  end
+
+  it "should make the checksum properties unique by default" do
+    subject.properties[:url_checksum].should be_unique
+  end
+
+  describe "checksum" do
+    let(:expected) { '2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824' }
+
+    it "should calculate SHA256 checksums" do
+      subject.calculate_checksum('hello').should == expected
+    end
+
+    it "should convert non-Strings to Strings" do
+      subject.calculate_checksum(:hello).should == expected
+    end
+  end
+
+  describe "checksum_query" do
+    let(:url) { 'http://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA' }
+    let(:url_checksum) { '7aea54fe73fda6bca28f47ea57f1af1a6bc7b28ef323a3b85763131baad46e8e' }
+
+    it "should not modify Undefined queries" do
+      subject.checksum_query(DataMapper::Undefined).should == DataMapper::Undefined
+    end
+
+    it "should replace checksumed properties with their checksums" do
+      new_query = subject.checksum_query({:url => url})
+
+      new_query.should_not have_key(:url)
+      new_query[:url_checksum].should == url_checksum
+    end
+
+    it "should not replace un-checksumed properties" do
+      new_query = subject.checksum_query({:id => 2, :url => url})
+
+      new_query[:id].should == 2
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-checksumed
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: A DataMapper plugin which adds checksum properties to a Model, referencing other properties.
+email: 
+- postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- ChangeLog.md
+- LICENSE.txt
+files: 
+- .document
+- .rspec
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dm-is-checksumed.gemspec
+- gemspec.yml
+- lib/dm-is-checksumed.rb
+- lib/dm-is-checksumed/is/checksumed.rb
+- spec/integration/checksumed_spec.rb
+- spec/models/url.rb
+- spec/spec_helper.rb
+- spec/unit/checksumed_spec.rb
+homepage: http://github.com/postmodern/dm-is-checksumed
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: dm-is-checksumed
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Adds checksum properties to DataMapper Models.
+test_files: 
+- spec/integration/checksumed_spec.rb
+- spec/unit/checksumed_spec.rb