activerecord-attributes 0.1.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 activerecord-attributes.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Charles Lowell
+
+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,42 @@
+# Activerecord::Attributes
+
+Just looking at an ActiveRecord class can be cognitively cumbersome. Not only do you have to comprehend all the
+scopes, relations, validations, etc, present in the file, but at the same time you have mentally
+overlay the database table that it represents in order to get the full picture.
+
+Why should you required to reconcile two related mental models in realtime in order to comprehend your own, or somebody
+else's code?
+
+`ActiveRecord::Attributes` is a simple way to annotate and sanity check your record classess so that they can be both
+understood and known to be correct.
+
+## Usage
+
+Declare attributes in your record class
+
+        class Artist < ActiveRecord::Base
+          attribute :name
+          attribute :discipline
+        end
+
+Upon loading this class, the attribute declaration will assert that the columns corresponding to `:name` and
+`:discipline` do indeed exist and fail fast otherwise.
+
+That's it!
+
+## Migrations
+
+Existential column assertions are all well and good, but in the context of migrations, the columns that back an
+active record's attributes could be in flux. For this reason, there is the facility to disable sanity checking:
+
+    ActiveRecord::Attributes.without_assertions do
+      Artist.find_by_passion('painting')
+    end
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-attributes'
+

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '--color --format documentation'
+end
+
+task :default => :spec

data/activerecord-attributes.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/activerecord-attributes/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["The Frontside"]
+  gem.email         = ["info@thefrontside.net"]
+  gem.description   = %q{Add simple attribute annotations to your active records}
+  gem.summary       = %q{Because not being able to see your actual class definition is a dev papercut}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "activerecord-attributes"
+  gem.require_paths = ["lib"]
+  gem.version       = Activerecord::Attributes::VERSION
+
+  gem.add_dependency 'activerecord'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+end

data/lib/activerecord-attributes.rb

@@ -0,0 +1,32 @@
+require "activerecord-attributes/version"
+require 'active_support'
+
+module ActiveRecord
+  module Attributes
+
+    def attribute(name)
+      return unless ActiveRecord::Attributes.with_assertions?
+      unless attribute_names.include? name.to_s
+        fail AttributeError, "#{self} does not actually have an attribute named #{name}"
+      end
+    end
+
+    def self.without_assertions
+      current = @disable_assertions
+      @disable_assertions = true
+      yield
+    ensure
+      @disable_assertions = current
+    end
+
+    def self.with_assertions?
+      !@disable_assertions
+    end
+
+    class AttributeError < StandardError; end
+  end
+
+  ActiveSupport.on_load(:active_record) do
+    extend Attributes
+  end
+end

data/lib/activerecord-attributes/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module Attributes
+    VERSION = "0.1.0"
+  end
+end

data/spec/activerecord-attributes_spec.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+require 'activerecord-attributes'
+
+describe "An active record" do
+  before do
+    ActiveRecord::Base.establish_connection({
+      :adapter => "sqlite3",
+      :database =>  File.expand_path('../artists.sqlite3', __FILE__)
+    })
+    @class = Class.new(ActiveRecord::Base)
+    @class.table_name = 'artists'
+  end
+  it "is ok with columns that exists" do
+    lambda {
+      @class.attribute :talent
+      @class.attribute :passion
+    }.should_not raise_error
+  end
+
+  it "complains when you specify an attribute with no corresponding column" do
+    lambda {
+      @class.attribute 'common_sense'
+    }.should raise_error(ActiveRecord::Attributes::AttributeError)
+  end
+
+  it "allows for disabling sanity checks when running migrations" do
+    ActiveRecord::Attributes.without_assertions do
+      lambda {
+        @class.attribute :starving
+      }.should_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.unshift File.expand_path '../../lib', __FILE_

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- The Frontside
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
+  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: Add simple attribute annotations to your active records
+email:
+- info@thefrontside.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-attributes.gemspec
+- lib/activerecord-attributes.rb
+- lib/activerecord-attributes/version.rb
+- spec/activerecord-attributes_spec.rb
+- spec/artists.sqlite3
+- spec/spec_helper.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: 3845241495246877097
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3845241495246877097
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Because not being able to see your actual class definition is a dev papercut
+test_files:
+- spec/activerecord-attributes_spec.rb
+- spec/artists.sqlite3
+- spec/spec_helper.rb