acts_as_digested_on 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_digested_on.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2012 milk1000cc
+
+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,70 @@
+= ActsAsDigestedOn
+
+acts_as_digested_on is a gem for Rails 3.
+
+This sets the digested value before validation and validates uniqueness of the digested value.
+
+If you use this gem for Rails 2, see rails-2 branch.
+
+== Install
+
+  sudo gem install acts_as_digested_on
+
+== Usage
+
+  # db/migrate/20090706000000_create_articles.rb
+  class CreateArticles < ActiveRecord::Migration
+    def self.up
+      create_table :articles do |t|
+        t.text :url       # any type is ok
+        t.string :digest  # this is sha-1 hex digest field of url value
+        ...
+      end
+
+      add_index :articles, :digest, :unique => true  # you can add index on digest field
+    end
+
+    def self.down
+      drop_table :articles
+    end
+  end
+
+  # app/models/article.rb
+  class Article < ActiveRecord::Base
+    acts_as_digested_on :url  # please add this
+    ...
+  end
+
+  # this means
+  class Article < ActiveRecord::Base
+    validates_uniqueness_of :digest
+    before_validation :set_digest
+
+    def generate_digest
+      Digest::SHA1.hexdigest "--#{ url.to_s }--"
+    end
+
+    private
+    def set_digest
+      self.digest = generate_digest
+    end
+    ...
+  end
+
+== Examples
+
+  acts_as_digested_on :url, :unique => false
+
+  acts_as_digested_on :url, :digest_column => :url_digest
+
+  acts_as_digested_on [:url, :salt]
+
+  acts_as_digested_on :url, :scope => :site_id
+
+  Article.new(:url => 'http://example.com').generate_digest
+
+== Copyright
+
+Copyright (c) 2009-2012 milk1000cc, released under the MIT license
+
+milk1000cc <mailto:info@milk1000.cc>

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/acts_as_digested_on.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_digested_on/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_digested_on"
+  s.version     = ActsAsDigestedOn::VERSION
+  s.authors     = ["milk1000cc"]
+  s.email       = ["info@milk1000.cc"]
+  s.homepage    = "https://github.com/milk1000cc/acts_as_digested_on"
+  s.summary     = %q{Automatically set sha-1 hex digest}
+  s.description = %q{This gem sets the digested value before validation and validates uniqueness of the digested value.}
+
+  s.rubyforge_project = "acts_as_digested_on"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_dependency "rails"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+end

data/lib/acts_as_digested_on.rb

@@ -0,0 +1,65 @@
+require "acts_as_digested_on/version"
+require 'digest/sha1'
+
+module ActsAsDigestedOn
+  def self.included(model)
+    model.extend ClassMethods
+  end
+
+  module Validations
+    def self.included(model)
+      model.class_eval do
+        options = acts_as_digested_on_vars[:validates_uniqueness_of_options]
+        validates_uniqueness_of acts_as_digested_on_vars[:digest_column], options
+      end
+    end
+  end
+
+  module Callbacks
+    def self.included(model)
+      model.class_eval do
+        before_validation :set_digest
+      end
+    end
+  end
+
+  module InstanceMethods
+    def generate_digest
+      original_columns = self.class.acts_as_digested_on_vars[:original_columns]
+      original_string = "--#{ original_columns.map { |v| self[v].to_s }.join('--') }--"
+      digest = Digest::SHA1.hexdigest(original_string)
+      digest.encode! 'utf-8' if RUBY_VERSION.to_f >= 1.9
+      digest
+    end
+
+    private
+    def set_digest
+      digest_column = self.class.acts_as_digested_on_vars[:digest_column]
+      self[digest_column] = generate_digest
+    end
+  end
+
+  module ClassMethods
+    def acts_as_digested_on(original_columns, options = {})
+      options = options.symbolize_keys
+
+      original_columns = Array(original_columns).flatten
+      digest_column = options.delete(:digest_column) || 'digest'
+      unique = options.key?(:unique) ? options.delete(:unique) : true
+
+      class_attribute :acts_as_digested_on_vars
+      self.acts_as_digested_on_vars = {
+        :original_columns => original_columns,
+        :digest_column => digest_column,
+        :unique => unique,
+        :validates_uniqueness_of_options => options
+      }
+
+      include InstanceMethods
+      include Callbacks
+      include Validations if self.acts_as_digested_on_vars[:unique]
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsDigestedOn

data/lib/acts_as_digested_on/version.rb

@@ -0,0 +1,3 @@
+module ActsAsDigestedOn
+  VERSION = "0.0.2"
+end

data/spec/acts_as_digested_on_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Article < ActiveRecord::Base
+  define_table do |t|
+    t.integer :user_id
+    t.string :title
+    t.text :url
+    t.string :digest
+    t.string :my_digest
+    t.text :content
+  end
+end
+
+describe "ActsAsDigestedOn" do
+  before do
+    Article.reset_callbacks :validate
+    Article.destroy_all
+  end
+
+  before do
+    @url = 'http://example.com'
+  end
+
+  describe '#generate_digest' do
+    it 'should generate sha-1 digest of target field with some string' do
+      Article.acts_as_digested_on :url
+
+      article = Article.new(:url => @url)
+      article.generate_digest.should == Digest::SHA1.hexdigest("--#{ @url }--")
+    end
+
+    describe 'when more than one target field is given' do
+      it 'should generate sha-1 digest of target fields with some string' do
+        Article.acts_as_digested_on [:title, :url]
+
+        title = 'an article'
+        article = Article.new(:title => title, :url => @url)
+        article.generate_digest.should == Digest::SHA1.hexdigest("--#{ title }--#{ @url }--")
+      end
+    end
+  end
+
+  describe 'before validation' do
+    it 'should set "digest" field' do
+      Article.acts_as_digested_on :url
+
+      article = Article.new(:url => @url)
+      article.digest.should be_nil
+      article.valid?
+      article.digest.should == article.generate_digest
+    end
+
+    it 'should set the digest value to :digest_column field when :digest_column option is set' do
+      Article.acts_as_digested_on :url, :digest_column => :my_digest
+
+      article = Article.new(:url => @url)
+      article.digest.should be_nil
+      article.my_digest.should be_nil
+      article.valid?
+      article.digest.should be_nil
+      article.my_digest.should == article.generate_digest
+    end
+  end
+
+  describe 'when validation' do
+    it 'should validate uniqueness of digest field by default' do
+      Article.acts_as_digested_on :url
+
+      Article.create! :url => @url
+      proc { Article.create!(:url => @url) }.should raise_error(ActiveRecord::RecordInvalid)
+      proc { Article.create!(:url => 'http://example2.com') }.should_not raise_error
+    end
+
+    it 'should carry over the options to the validates_uniqueness_of options' do
+      Article.acts_as_digested_on :url, :scope => :user_id
+
+      Article.create! :url => @url, :user_id => 1
+      proc { Article.create!(:url => @url, :user_id => 1) }.should raise_error(ActiveRecord::RecordInvalid)
+      proc { Article.create!(:url => @url, :user_id => 2) }.should_not raise_error
+      proc { Article.create!(:url => 'http://example2.com', :user_id => 1) }.should_not raise_error
+    end
+
+    it 'should validate uniqueness of digest field when :unique option is true' do
+      Article.acts_as_digested_on :url, :unique => true
+
+      Article.create! :url => @url
+      proc { Article.create!(:url => @url) }.should raise_error(ActiveRecord::RecordInvalid)
+      proc { Article.create!(:url => 'http://example2.com') }.should_not raise_error
+    end
+
+    it 'should not validate uniqueness of digest field when :unique option is false' do
+      Article.acts_as_digested_on :url, :unique => false
+
+      Article.create! :url => @url
+      proc { Article.create!(:url => @url) }.should_not raise_error
+    end
+
+    it 'should support string key options' do
+      Article.acts_as_digested_on :url, 'unique' => false
+
+      Article.create! :url => @url
+      proc { Article.create!(:url => @url) }.should_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'logger'
+require 'rspec'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'acts_as_digested_on'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+class ActiveRecord::Base
+  def self.define_table(table_name = self.name.tableize, &migration)
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table(table_name, &migration)
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_digested_on
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- milk1000cc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70338358717700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70338358717700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70338358717280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70338358717280
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70338358716860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70338358716860
+description: This gem sets the digested value before validation and validates uniqueness
+  of the digested value.
+email:
+- info@milk1000.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- acts_as_digested_on.gemspec
+- lib/acts_as_digested_on.rb
+- lib/acts_as_digested_on/version.rb
+- spec/acts_as_digested_on_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/milk1000cc/acts_as_digested_on
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: acts_as_digested_on
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Automatically set sha-1 hex digest
+test_files:
+- spec/acts_as_digested_on_spec.rb
+- spec/spec_helper.rb