milk1000cc-acts_as_digested_on 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 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,72 @@
+= ActsAsDigestedOn
+
+acts_as_digested_on is a rails plugin.
+
+This sets the digested value before validation and validates uniqueness of the digested value.
+
+== Install
+
+  sudo gem install milk1000cc-acts_as_digested_on --source=http://gems.github.com
+
+or
+
+  script/plugin install git://github.com/milk1000cc/acts_as_digested_on.git
+
+== 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 milk1000cc, released under the MIT license
+
+milk1000cc <mailto:info@milk1000.cc>

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_digested_on"
+    gem.description = 'A rails plugin to set the digested value before validation and validate uniqueness.'
+    gem.summary = %Q{automatically set sha-1 hex digest}
+    gem.email = "info@milk1000.cc"
+    gem.homepage = "http://github.com/milk1000cc/acts_as_digested_on"
+    gem.authors = ["milk1000cc"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+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 = "acts_as_digested_on #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

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

data/acts_as_digested_on.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_digested_on}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["milk1000cc"]
+  s.date = %q{2009-07-07}
+  s.description = %q{A rails plugin to set the digested value before validation and validate uniqueness.}
+  s.email = %q{info@milk1000.cc}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_digested_on.gemspec",
+     "init.rb",
+     "lib/acts_as_digested_on.rb",
+     "spec/acts_as_digested_on_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/milk1000cc/acts_as_digested_on}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{automatically set sha-1 hex digest}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/acts_as_digested_on_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'acts_as_digested_on'

data/lib/acts_as_digested_on.rb

@@ -0,0 +1,62 @@
+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::SHA1.hexdigest original_string
+    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_inheritable_hash :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/spec/acts_as_digested_on_spec.rb

@@ -0,0 +1,107 @@
+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
+    (ActiveRecord::Callbacks::CALLBACKS + [:validate, :validate_on_create, :validate_on_update]).each do |cb|
+      Article.instance_variable_set "@#{ cb }_callbacks", nil
+    end
+    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,21 @@
+require 'rubygems'
+require 'spec'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'acts_as_digested_on'
+
+Spec::Runner.configure do |config|
+  
+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,65 @@
+--- !ruby/object:Gem::Specification 
+name: milk1000cc-acts_as_digested_on
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- milk1000cc
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A rails plugin to set the digested value before validation and validate uniqueness.
+email: info@milk1000.cc
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_digested_on.gemspec
+- init.rb
+- lib/acts_as_digested_on.rb
+- spec/acts_as_digested_on_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/milk1000cc/acts_as_digested_on
+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.2.0
+signing_key: 
+specification_version: 2
+summary: automatically set sha-1 hex digest
+test_files: 
+- spec/spec_helper.rb
+- spec/acts_as_digested_on_spec.rb