activerecord-relations_annotations 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ca4b86b9a7472d5974ae27ede0a4d5f17754d96
+  data.tar.gz: 6749de01c00c1d87c0a5d5f991a89b89e1746c07
+SHA512:
+  metadata.gz: c823c5ac2531808e582e9f5fe2d269bd9755a029ad85d2f870ed5f8004fe0b1fd9b49dd3f3eee722e1820e856af9059a9993a73928189399d046c50a2371b967
+  data.tar.gz: d50858a412b93831b6cdd52c3b3880cb3ea6ed6fe985875db70f0243876db4d6ff6c6ba78722ba743f8fe1592d1653557c94aeab42b2d3dbe543a3a9b2e603f8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Fire-Dragon-DoL
+
+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,130 @@
+# RelationsAnnotations
+
+Annotate ActiveRecord relations objects with custom data, allowing metadata
+on relations that can be used to customize code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-relations_annotations', '~> 0.0.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-relations_annotations
+
+## Usage
+
+Not the greatest example, but gives you a rough idea:
+
+```ruby
+class User < ActiveRecord::base
+  include ActiveRecord::RelationsAnnotations
+end
+
+users = User.where.not(email: nil)
+with_email_users = users.annotate(:with_email? => true)
+without_email_users = users.annotate(:with_email? => false)
+
+if with_email_users.annotations.with_email?
+  # Do some stuff
+end
+
+unless without_email_users.annotations.with_email?
+  # Do other stuff on this group of users
+end
+```
+
+Annotations can also be accessed in a hash-fashion, like on `OpenStruct`:
+
+```ruby
+users = User.where(email: 'foo').annotate(foo: 'bar')
+
+users.annotations[:foo] # => 'bar'
+users.annotations[:something] # => nil
+```
+
+## Documentation
+
+`#annotate(**values)` accepts a hash, values are merged into the **annotations**
+`OpenStruct`, it returns a new `ActiveRecord::Relation` based on the one is
+called on.
+If it's called as the first method (directly on model class), it behaves like
+it's called on `all` method.
+
+`annotations` method returns an `OpenStruct` with all annotations set on the
+relation.
+
+`annotated` method should not be used, basically ensures we are in an
+`ActiveRecord::Relation` and ensures the annotations `OpenStruct` exists, so
+even in case it's called, it won't do any damage.
+
+## Features
+
+### Chainable
+
+```ruby
+User.where.not(email: 'foo').
+  annotate(testme: 123, blah: 'hi').
+  annotate(foo: 'bar').
+  where(something: 'else').
+  annotations
+# => <OpenStruct testme=123, blah='hi', something='else'>
+```
+
+### Always returns an OpenStruct
+
+```ruby
+User.annotations
+# => <OpenStruct>
+```
+
+```ruby
+User.where.not(email: 'foo').annotations
+# => <OpenStruct>
+```
+
+### It always creates a relation
+
+```ruby
+User.annotate(foo: 'bar').class
+# => User::ActiveRecord_Relation
+```
+
+## Gotchas
+
+When you call methods on relations, they create new values, much like `map` for
+array, which creates a new array.
+This means the following:
+
+```ruby
+tmp = User.where.name(email: 'foo')
+
+tmp2 = tmp.annotate(bar: 'baz')
+
+tmp.annotations # => <OpenStruct>
+tmp2.annotations # => <OpenStruct bar='baz'>
+```
+
+It shouldn't be a problem, though, because it's standard
+`ActiveRecord::Relation` behavior.
+
+## How it works
+Functionality is simple, the only _hack_ is that when `annotate`, `annotated`
+and `annotations` are called, a instance variable is created (if missing),
+called `@_annotations` and it's used to read values, through
+`instance_variable_set` and `instance_variable_get`.
+
+## Contributing
+
+1. Fork it ( https://github.com/Fire-Dragon-DoL/activerecord-relations_annotations/fork )
+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 a new Pull Request

data/Rakefile

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

data/activerecord-relations_annotations.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/relations_annotations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-relations_annotations"
+  spec.version       = ActiveRecord::RelationsAnnotations::VERSION
+  spec.authors       = ["Fire-Dragon-DoL"]
+  spec.email         = ["francesco.belladonna@gmail.com"]
+  spec.summary       = %q{Annotate ActiveRecord relations objects with custom data}
+  spec.description   = %q{Annotate ActiveRecord relations objects with custom data, allowing metadata on relations that can be used to customize code}
+  spec.homepage      = "https://github.com/Fire-Dragon-DoL/activerecord-relations_annotations"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.1.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-byebug"
+
+  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "activerecord",  "~> 4.0"
+end

data/lib/active_record/relations_annotations.rb

@@ -0,0 +1,37 @@
+require 'ostruct'
+require 'active_record'
+require 'active_support/concern'
+require 'active_record/relations_annotations/version'
+
+module ActiveRecord
+  module RelationsAnnotations
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def annotate(**values)
+        annotated.tap do |relation|
+          values.each do |key, value|
+            relation.instance_variable_get(:@_annotations)[key.to_sym] = value
+          end
+        end
+      end
+
+      def annotations
+        annotated.instance_variable_get(:@_annotations)
+      end
+
+      # This should never be explicitly called, but if done, nothing should
+      # happen
+      def annotated
+        all.tap do |relation|
+          if relation.instance_variable_get(:@_annotations).nil?
+            relation.instance_variable_set(:@_annotations, OpenStruct.new)
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/active_record/relations_annotations/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module RelationsAnnotations
+    VERSION = "0.0.1"
+  end
+end

data/spec/active_record/relations_annotations_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'active_record/relations_annotations'
+require 'support/dummy'
+
+RSpec.describe ActiveRecord::RelationsAnnotations do
+  subject { Dummy.where(name: nil) }
+
+  it "creates dummy correctly" do
+    expect{Dummy.create}.not_to raise_error
+  end
+
+  describe "#annotated" do
+
+    it "is always a relation" do
+      expect(subject.annotated.class).to be < ActiveRecord::Relation
+    end
+
+  end
+
+  describe "#annotate" do
+
+    it "can annotate fetched relation" do
+      expect{subject.annotate(foo: 'bar')}.not_to raise_error
+    end
+
+    it "is chainable" do
+      expect{subject.annotate(foo: 'bar').where(name: 'baz')}.not_to raise_error
+    end
+
+    it "keeps annotation when adding conditions to query" do
+      expect(
+        subject.annotate(foo: 'bar').where(name: 'baz').annotations.foo
+      ).to eq 'bar'
+    end
+
+    it "is always a relation" do
+      expect(subject.annotate(foo: 'bar').class).to be < ActiveRecord::Relation
+    end
+
+  end
+
+  describe "#annotations" do
+
+    it "contains annotated values" do
+      expect(
+        subject.annotate(foo: 'bar').annotations.foo
+      ).to eq 'bar'
+    end
+
+    it "has nil values when annotation not present" do
+      expect(subject.annotations[:foo]).to be_nil
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH << File.expand_path('..', __FILE__).to_s
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  # config.warnings = true
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.order = :random
+  Kernel.srand config.seed
+end

data/spec/support/config/active_record.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+require 'sqlite3'
+
+# ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+) 
+
+ActiveRecord::Schema.verbose = false
+
+ActiveRecord::Schema.define do
+
+  create_table :dummies, force: true do |t|
+    t.column :name, :string
+  end
+
+end

data/spec/support/dummy.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+require 'active_record/relations_annotations'
+require 'support/config/active_record'
+
+class Dummy < ActiveRecord::Base
+  include ActiveRecord::RelationsAnnotations
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-relations_annotations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fire-Dragon-DoL
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: pry
+  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: pry-remote
+  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: pry-byebug
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Annotate ActiveRecord relations objects with custom data, allowing metadata
+  on relations that can be used to customize code
+email:
+- francesco.belladonna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-relations_annotations.gemspec
+- lib/active_record/relations_annotations.rb
+- lib/active_record/relations_annotations/version.rb
+- spec/active_record/relations_annotations_spec.rb
+- spec/spec_helper.rb
+- spec/support/config/active_record.rb
+- spec/support/dummy.rb
+homepage: https://github.com/Fire-Dragon-DoL/activerecord-relations_annotations
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Annotate ActiveRecord relations objects with custom data
+test_files:
+- spec/active_record/relations_annotations_spec.rb
+- spec/spec_helper.rb
+- spec/support/config/active_record.rb
+- spec/support/dummy.rb