at_most 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bd7ccf7a5bea7d3f9f4c2764ab736c644d108b7
+  data.tar.gz: 495c24dd455301c852a017a6908ce29eb517e120
+SHA512:
+  metadata.gz: 3e173a6ca74f8f4de2371c31fc577b05de12a5bede44d73d5ecdc1814e6f132f2b0b5edb07452a053ba643f927db7bdef6a897917bedd38ec85e17222a7fd4d8
+  data.tar.gz: fc21d8009d3531793e8733ef297fb5c6c319c3c9326f10a79891ad01a88933209b1c71bf91c7b357956d304694f47c478e10d044b967936760e044f1fdd71547

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kristian Freeman
+
+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,85 @@
+# at_most
+
+[![Travis
+badge](https://travis-ci.org/imkmf/at_most.png)](https://travis-ci.org/imkmf/at_most)
+
+[![Code
+Climate](https://codeclimate.com/github/imkmf/at_most.png)](https://codeclimate.com/github/imkmf/at_most)
+
+[![Coverage
+Status](https://coveralls.io/repos/imkmf/at_most/badge.png)](https://coveralls.io/r/imkmf/at_most)
+
+A simple extension to ActiveRecord to allow limiting of model creation via
+validation. This gem was extracted out of a Rails app function that limited the
+number of users that could be created with CRUD access to a different AR model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'at_most'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install at_most
+
+## Usage
+
+```ruby
+# app/models/user.rb
+
+class User < ActiveRecord::Base
+  at_most(5)
+end
+
+```
+
+```shell
+
+# after fifth User instance, in IRB
+> User.create!
+  ActiveRecord::RecordInvalid: Validation failed: The maximum number of users has
+been reached.
+```
+
+It's really that simple.
+
+# Errors
+
+You can specify custom errors in the model, or through i18n:
+
+```ruby
+# app/models/user.rb
+
+class User < ActiveRecord::Base
+  at_most(5, { message: "Sorry, all our spots are full!" })
+end
+```
+
+There are two i18n options: a **per model** setting, and a *global* setting.
+
+```yaml
+en:
+  activerecord:
+    errors:
+      models:
+        users:
+          at_most: "All of our spots are full :(:("
+        books:
+          at_most: "I can't read all of these!"
+  at_most: "Something went terribly wrong."
+```
+
+## Contributing
+
+Running tests -- the default `rake` task runs the Rspec suite.
+
+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,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/at_most.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'at_most/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "at_most"
+  spec.version       = AtMost::VERSION
+  spec.authors       = ["Kristian Freeman"]
+  spec.email         = ["kristian@kristianfreeman.com"]
+  spec.description   = %q{Limit your ActiveRecord models}
+  spec.summary       = %q{A simple extension to ActiveRecord to allow limiting of model creation via validation. This gem was extracted out of a Rails app function that limited the number of users that could be created with CRUD access to a different AR model.}
+  spec.homepage      = "https://github.com/imkmf/at_most"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/at_most.rb

@@ -0,0 +1,30 @@
+require "at_most/version"
+require "active_record/base"
+
+def downcase_and_pluralize(input)
+  return "#{ input.to_s.downcase }s"
+end
+
+def validation_error(model, message)
+  message || i18n_error(model) || "Maximum number of #{model.class}s has been reached"
+end
+
+def i18n_error(model)
+  if !I18n.t("activerecord.errors.models.#{ downcase_and_pluralize(model.class) }.at_most").include?("missing")
+    I18n.t("activerecord.errors.models.#{ downcase_and_pluralize(model.class) }.at_most")
+  elsif !I18n.t("at_most").include?("missing")
+    I18n.t("at_most")
+  end
+end
+
+class ActiveRecord::Base
+  def self.at_most(limiter, options = {})
+    validate do |model|
+      @all = self.class.all
+      @count = @all.is_a?(ActiveRecord::Relation) ? @all.size : @all.count
+      if @count >= limiter
+        model.errors.add :base, validation_error(model, options[:message])
+      end
+    end
+  end
+end

data/lib/at_most/version.rb

@@ -0,0 +1,3 @@
+module AtMost
+  VERSION = "0.0.1"
+end

data/spec/active_record_spec_helper.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+require 'spec_helper'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+ActiveRecord::Migration.create_table :users do |t|
+  t.timestamps
+end
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end
+
+I18n.load_path = Dir['spec/*.yml']
+I18n.backend.load_translations

data/spec/en.yml

@@ -0,0 +1,7 @@
+en:
+  at_most: "Fallback"
+  activerecord:
+    errors:
+      models:
+        users:
+          at_most: "NOOO!"

data/spec/models/user.rb

@@ -0,0 +1,5 @@
+require 'at_most'
+
+class User < ActiveRecord::Base
+  at_most(3)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/user_spec.rb

@@ -0,0 +1,43 @@
+require 'active_record_spec_helper'
+require 'models/user'
+
+describe User do
+  def three_times(klass)
+    3.times do
+      klass.create
+    end
+  end
+
+  class UserWithError < User
+    at_most(3, { message: "KHAAAN" })
+  end
+
+  class Book < User; end
+
+  describe 'at_most(3)' do
+    it 'should not fail when under the user limit' do
+      User.create.should be_valid
+    end
+
+    it 'should make objects up to the limit without failing' do
+      lambda { three_times(User) }.should_not raise_error
+    end
+
+    it 'should fail on the fourth creation' do
+      three_times(User)
+      User.create.should_not be_valid
+    end
+
+    it 'should accept a custom error in the method' do
+      three_times(UserWithError)
+      # en.activerecord.errors.models.users.at_most
+      UserWithError.create.errors.inspect.should include("KHAAAN")
+    end
+
+    it 'should prefer a specific i18n option' do
+      three_times(Book)
+      # en.at_most
+      Book.create.errors.inspect.should include("Fallback")
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: at_most
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kristian Freeman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Limit your ActiveRecord models
+email:
+- kristian@kristianfreeman.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- at_most.gemspec
+- lib/at_most.rb
+- lib/at_most/version.rb
+- spec/active_record_spec_helper.rb
+- spec/en.yml
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/user_spec.rb
+homepage: https://github.com/imkmf/at_most
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A simple extension to ActiveRecord to allow limiting of model creation via
+  validation. This gem was extracted out of a Rails app function that limited the
+  number of users that could be created with CRUD access to a different AR model.
+test_files:
+- spec/active_record_spec_helper.rb
+- spec/en.yml
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/user_spec.rb