unique_by_date 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bryan Ricker
+
+MIT License
+
+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,59 @@
+# UniqueByDate
+
+A validator for Rails which allows you to validate the uniqueness of an attribute, scoped by a date attribute on the same model. Useful for when your URL's contain a URL slug and a date.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'unique_by_date'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unique_by_date
+
+
+## Usage
+
+It works just like a normal validator. It has two special parameters (aside from the ones provided by ActiveModel::EachValidator). Both parameters are required:
+
+* `scope` - The date or datetime attribute by which to scope the uniqueness of the attribute being validated. So if you want a `url_slug` attribute to be unique based on a `published_at` timestamp, then you would add `scope: :published_at`.
+* `filter` - How the scoped attribute (i.e. `published_at`) should be filtered when validating. If you want every slug to be unique by each month, you would add `filter: :month`. The validator uses [ActiveSupport's Date Calculations](http://apidock.com/rails/ActiveSupport/CoreExtensions/Date/Calculations), so you may use any of those available filters: `:hour, :day, :week, :month, :quarter, :year`.
+
+You should also add a custom message, or add the message to your locales file.
+Here's an example:
+
+```ruby
+class Event < ActiveRecord::Base
+  # Schema:
+  # create_table :events do |t|
+  #   t.string :title
+  #   t.string :url_slug
+  #   t.datetime :starts_at
+  #   t.datetime :ends_at
+  # end
+  #
+  # Route:
+  # get 'events/:year/:month/:day/:slug' => 'events#show'
+
+  validates :slug, unique_by_date: {
+    :scope   => :starts_at,
+    :filter  => :day,
+    :message => "must be unique for each starts_at day."
+  }
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/unique_by_date.rb

@@ -0,0 +1,7 @@
+require "unique_by_date/version"
+require 'active_record'
+require 'unique_by_date_validator'
+
+module UniqueByDate
+end
+

data/lib/unique_by_date/version.rb

@@ -0,0 +1,3 @@
+module UniqueByDate
+  VERSION = "1.0.0"
+end

data/lib/unique_by_date_validator.rb

@@ -0,0 +1,66 @@
+##
+# Unique By validator
+# Makes sure an attribute is unique by a specified day, month, year, etc.
+# This validator is heavily based on ActiveRecord::Validations::UniquenessValidator
+#
+# It uses the `beginning_of_*` and `end_of_*` methods to
+# specify the range of dates for which the attribute must be unique
+# ActiveSupport::CoreExtensions::Date::Calculations
+# http://apidock.com/rails/ActiveSupport/CoreExtensions/Date/Calculations
+#
+# `scope` must be a datetime field
+# Filter options are: [:hour, :day, :week, :month, :quarter, :year]
+#
+# Usage:
+#
+#   validates :slug, unique_by_date: { scope: :starts_at, filter: :day }
+#
+class UniqueByDateValidator < ActiveModel::EachValidator
+  def setup(klass)
+    @klass = klass
+  end
+
+  #---------------
+
+  def validate_each(record, attribute, value)
+    finder_class = find_finder_class_for(record)
+    table        = finder_class.arel_table
+
+    coder = record.class.serialized_attributes[attribute.to_s]
+
+    if value && coder
+      value = coder.dump value
+    end
+
+    relation = table[attribute].eq(value)
+    relation = relation.and(table[finder_class.primary_key.to_sym].not_eq(record.send(:id))) if record.persisted?
+
+    scope_value = record.read_attribute(options[:scope])
+    return true if !scope_value
+
+    low_limit  = scope_value.send("beginning_of_#{options[:filter]}")
+    high_limit = scope_value.send("end_of_#{options[:filter]}")
+
+    relation = relation.and(table[options[:scope]].gteq(low_limit))
+    relation = relation.and(table[options[:scope]].lt(high_limit))
+    relation = finder_class.unscoped.where(relation)
+
+    if relation.exists?
+      record.errors.add(attribute, :taken, options.merge(value: value))
+    end
+  end
+
+  #---------------
+
+  protected
+
+  def find_finder_class_for(record) #:nodoc:
+    class_hierarchy = [record.class]
+
+    while class_hierarchy.first != @klass
+      class_hierarchy.prepend(class_hierarchy.first.superclass)
+    end
+
+    class_hierarchy.detect { |klass| !klass.abstract_class? }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'unique_by_date'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => File.join(File.dirname(__FILE__), "test.sqlite3")
+)
+
+load File.join(File.dirname(__FILE__), "support", "models.rb")
+
+RSpec.configure do |config|
+  config.before do
+    load File.join(File.dirname(__FILE__), "support", "schema.rb")
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,4 @@
+class Event < ActiveRecord::Base
+  validates :slug, unique_by_date: { scope: :starts_at, filter: :day, allow_blank: true, message: "not unique." }
+  validates :title, unique_by_date: { scope: :starts_at, filter: :month, allow_blank: true, message: "not unique." }
+end

data/spec/support/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :events, force: true do |t|
+    t.string :title
+    t.string :slug
+    t.datetime :starts_at
+  end
+end

data/spec/unique_by_date_validator_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe UniqueByDateValidator do
+  it 'is not valid if another exists with given parameters' do
+    event1 = Event.create(slug: "same", starts_at: 1.day.ago)
+    event2 = Event.new(slug: "same", starts_at: 1.day.ago)
+
+    event2.should_not be_valid
+  end
+
+  it 'is valid if dates are not in the same scope' do
+    event1 = Event.create(slug: "same", starts_at: 3.days.ago)
+    event2 = Event.new(slug: "same", starts_at: 1.day.ago)
+
+    event2.valid?
+    puts event2.errors.full_messages
+    event2.should be_valid
+  end
+
+  it "is valid if the attribute is already unique" do
+    event1 = Event.create(slug: "same", starts_at: 1.day.ago)
+    event2 = Event.new(slug: "notsame", starts_at: 1.day.ago)
+
+    event2.should be_valid
+  end
+
+  it 'can use a different filter' do
+    event1 = Event.create(title: "same", starts_at: 1.day.ago)
+    event2 = Event.new(title: "same", starts_at: 2.days.ago)
+
+    # in models.rb, title uniqueness if filtered by month
+    event2.should_not be_valid
+
+    event2.starts_at = 3.months.ago
+    event2.should be_valid
+  end
+end

data/unique_by_date.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unique_by_date/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unique_by_date"
+  spec.version       = UniqueByDate::VERSION
+  spec.authors       = ["Bryan Ricker"]
+  spec.email         = ["bricker88@gmail.com"]
+  spec.description   = %q{A Rails validator for uniqueness by date.}
+  spec.summary       = %q{A validator for Rails which allows you to validate the uniqueness of an attribute, scoped by a date attribute on the same model. Useful for when your URL's contain a URL slug and a date.}
+  spec.homepage      = "https://github.com/bricker/unique_by_date"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "sqlite3-ruby"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: unique_by_date
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Bryan Ricker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails validator for uniqueness by date.
+email:
+- bricker88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/unique_by_date.rb
+- lib/unique_by_date/version.rb
+- lib/unique_by_date_validator.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/test.sqlite3
+- spec/unique_by_date_validator_spec.rb
+- unique_by_date.gemspec
+homepage: https://github.com/bricker/unique_by_date
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A validator for Rails which allows you to validate the uniqueness of an attribute,
+  scoped by a date attribute on the same model. Useful for when your URL's contain
+  a URL slug and a date.
+test_files:
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/test.sqlite3
+- spec/unique_by_date_validator_spec.rb