virtus-group 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDRlZmRjNDc5MWI5MGZmNGRiOGUzMTMzY2NjNjAyNDY4OTU1NTkwZA==
+  data.tar.gz: !binary |-
+    YzEzMDgyODNlYjJjNmNjYjNlZjhiNTA1NDQ0NTFjZjA4MTdkNjMwNg==
+SHA512:
+  metadata.gz: !binary |-
+    MzFiYmRlNjJjNjZmZjZkZDMwNzFhYWRkOGI1NzBhNmU1YTkwN2NlYjk0Zjlh
+    OWMwYjUwM2Q2M2Q0NDJmYzc1ODI0YWVhYmY2MGMwZWM2NzlmNjlkNDBmYWUx
+    MjZlM2I0ZmJmNWUwOGQ2ODYwMWU5ZDRjOWVlZGM4MjhlYmQ0NmQ=
+  data.tar.gz: !binary |-
+    NjZhMzllNWM5NTdiOGRiZGZhNGY3ODY3MDk3ZmNhMjE0YTdmMTc3OTY2NjFm
+    OTA3MGQ2NDIzM2I1YWQ1ODk2YjkyMDZkMWZkMTNjYWZkNzNjOGIyNWNmODNk
+    ZGE4MmU1MTYxZWNiMmU2NmU0M2JhZDJlMDI1MWNmMGYwOTgxMDI=

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+virtus-group

data/.ruby-version

@@ -0,0 +1,4 @@
+ruby-1.9.3-p484
+
+
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in virtus-group.gemspec
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.14'
+  gem 'pry'
+end
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Spas Poptchev
+
+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,104 @@
+# Virtus.group
+
+The idea of this gem is to define groups over virtus attributes.
+Which is especially useful when you are working with [form objects](http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'virtus-group'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install virtus-group
+
+## Usage
+
+```ruby
+class SignUpForm
+  include Virtus.model
+  include Virtus.group
+
+  group :user do
+    attribute :email, String
+    attribute :password, String
+  end
+
+  group :address do
+    attribute :street, String
+    attribute :zipcode, String
+    attribute :city, String
+  end
+end
+```
+
+Don't worry, the `SignUpForm` class will still behave like a regular Virtus class.
+
+```ruby
+# ---
+
+SignUpForm.attribute_group
+# => {user: [:email, :password], address: [:street, :zipcode, :city]}
+
+SignUpForm.attribute_group[:user]
+# => [:email, :password]
+
+SignUpForm.attribute_group[:address]
+# => [:street, :zipcode, :city]
+
+# ---
+
+sign_up_form = SignUpForm.new({
+  email: 'john@example.com', password: '12344321',
+  street: 'ABC-Street 1', zipcode: 'Z1234', city: 'ABC'
+})
+
+sign_up_form.attributes_for :user
+# => {email: 'john@example.com', password: '12344321'}
+
+sign_up_form.attributes_for :address
+# => {street: 'ABC-Street 1', zipcode: 'Z1234', city: 'ABC'}
+```
+
+Let's say you have a `create` method on your `SignUpForm` you can use the attribute groups to create your models:
+
+```ruby
+class SignUpForm
+  include Virtus.model
+  include Virtus.group
+
+  group :user do
+    attribute :email, String
+    attribute :password, String
+  end
+
+  group :address do
+    attribute :street, String
+    attribute :zipcode, String
+    attribute :city, String
+  end
+
+  def create
+    user = User.build(attributes_for(:user))
+    user.build_address(attributes_for(:address))
+    user.save
+  end
+end
+```
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/spoptchev/virtus-group/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 new Pull Request
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+

data/lib/virtus/group.rb

@@ -0,0 +1,43 @@
+require "virtus/group/version"
+require "virtus/group/attribute_tracker"
+
+module Virtus
+
+  # stick to virtus api
+  def self.group
+    mod = Module.new
+    mod.define_singleton_method :included do |object|
+      object.send(:include, Group)
+    end
+    mod
+  end
+
+  module Group
+
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+
+      def group(name, &block)
+        attribute_tracker = AttributeTracker.new(self, &block)
+        attribute_group[name] = attribute_tracker.tracked_attributes
+      end
+
+      def attribute_group
+        @attribute_group ||= {}
+      end
+
+    end
+
+    def attributes_for(group_name)
+      attributes_in_group = self.class.attribute_group[group_name.to_sym]
+      self.attributes.select{|attribute, _| attributes_in_group.include?(attribute)}
+    end
+    alias :with_attributes_for :attributes_for
+
+  end
+end

data/lib/virtus/group/attribute_tracker.rb

@@ -0,0 +1,25 @@
+require 'delegate'
+
+module Virtus
+  module Group
+
+    class AttributeTracker < SimpleDelegator
+
+      def initialize(clazz, &block)
+        super(clazz)
+        instance_eval(&block)
+      end
+
+      def attribute(*args)
+        tracked_attributes << args.first.to_sym
+        super
+      end
+
+      def tracked_attributes
+        @tracked_attributes ||= []
+      end
+
+    end
+
+  end
+end

data/lib/virtus/group/version.rb

@@ -0,0 +1,5 @@
+module Virtus
+  module Group
+    VERSION = "0.0.1"
+  end
+end

data/spec/integration/virtus_group_integration_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+shared_examples 'a virtus object' do
+  it "should return the attributes" do
+    expect(model.attributes).to eq attributes
+  end
+end
+
+shared_examples 'an object with a virtus group' do
+  let(:model) { model_class.new(attributes) }
+
+  describe "#attributes_for" do
+    it "should return the attributes for the user group" do
+      expect(model.attributes_for(:user)).to eq user_attributes
+    end
+
+    it "should not return any attributes of the address group" do
+      expect(model.attributes_for(:user)).not_to include address_attributes
+    end
+
+    it "should return the attributes for the address group" do
+      expect(model.attributes_for(:address)).to eq address_attributes
+    end
+
+    it "should not return any attributes for the user group" do
+      expect(model.attributes_for(:address)).not_to include user_attributes
+    end
+  end
+
+  it_behaves_like "a virtus object"
+end
+
+describe Virtus::Group do
+
+  let(:user_attributes) { Hash[email: 'john@example.com'] }
+  let(:address_attributes) { Hash[city: 'Home'] }
+  let(:attributes) { user_attributes.merge(address_attributes) }
+
+  it_behaves_like 'an object with a virtus group' do
+    let(:model_class) do
+      Class.new do
+        include Virtus.model
+        include Virtus.group
+
+        group :user do
+          attribute :email, String
+        end
+
+        group :address do
+          attribute :city, String
+        end
+      end
+    end
+  end
+
+  it_behaves_like 'an object with a virtus group' do
+    let(:model_class) do
+      Class.new do
+        include Virtus.value_object
+        include Virtus.group
+
+        values do
+          group :user do
+            attribute :email, String
+          end
+
+          group :address do
+            attribute :city, String
+          end
+        end
+      end
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'pry'
+require 'virtus'
+require 'virtus/group'
+
+Dir[File.expand_path("../support/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.order = "random"
+end

data/spec/unit/group/attribute_tracker_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Virtus::Group::AttributeTracker do
+
+  let(:model_class) { Class.new.send(:include, Virtus.group) }
+
+  describe "#attribute" do
+    let(:proc) { Proc.new { attribute(:email, String) } }
+
+    it "should add the attribute to tracked_attributes" do
+      expect(model_class).to receive(:attribute).with(:email, String)
+      instance = described_class.new(model_class, &proc)
+      expect(instance.tracked_attributes).to include :email
+    end
+  end
+
+  describe "#tracked_attributes" do
+    let(:proc) { Proc.new {} }
+    let(:instance) { described_class.new(model_class, &proc) }
+
+    it "should return an empty array" do
+      expect(instance.tracked_attributes).to eq []
+    end
+  end
+
+end

data/spec/unit/virtus_group_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe Virtus::Group do
+
+  let(:model_class) { Class.new.send(:include, Virtus.group) }
+
+  describe ".group" do
+    let(:attribute_tracker_instance) { double(:attribute_tracker_instance) }
+    let(:proc) { Proc.new {} }
+    let(:tracked_attributes) { [:email] }
+    let(:group_name) { :user }
+
+    it "should add tracked attributes to an attribute group" do
+      expect(Virtus::Group::AttributeTracker).to receive(:new).once.
+        with(model_class, &proc).and_return(attribute_tracker_instance)
+
+      expect(attribute_tracker_instance).to receive(:tracked_attributes).once.and_return(tracked_attributes)
+
+      expect(model_class.group(group_name, &proc)).to eq tracked_attributes
+      expect(model_class.attribute_group[group_name]).to eq tracked_attributes
+    end
+  end
+
+  describe ".attribute_group" do
+    it "should return an empty hash" do
+      expect(model_class.attribute_group).to eq Hash.new
+    end
+  end
+
+  describe "#attributes_for" do
+    let(:attribute_group) { Hash[user: [:email, :password], address: [:city]] }
+    let(:instance) { model_class.new }
+    let(:attributes) { Hash[email: 'john@example.com', password: '12344321', city: 'Home'] }
+
+    it "should return all attributes and their values in the selected group" do
+      expect(model_class).to receive(:attribute_group).once.and_return(attribute_group)
+      expect(instance).to receive(:attributes).once.and_return(attributes)
+
+      result = instance.attributes_for(:user)
+      expect(result).to eq Hash[email: 'john@example.com', password: '12344321']
+      expect(result).not_to include :city
+    end
+  end
+
+end
+
+

data/virtus-group.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/virtus/group/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "virtus-group"
+  spec.version       = Virtus::Group::VERSION
+  spec.authors       = ["Spas Poptchev"]
+  spec.email         = ["spas.poptchev@me.com"]
+  spec.description   = %q{Define groups over virtus attributes.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/spoptchev/virtus-group"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "virtus", ">= 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: virtus-group
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Spas Poptchev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: Define groups over virtus attributes.
+email:
+- spas.poptchev@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/virtus/group.rb
+- lib/virtus/group/attribute_tracker.rb
+- lib/virtus/group/version.rb
+- spec/integration/virtus_group_integration_spec.rb
+- spec/spec_helper.rb
+- spec/unit/group/attribute_tracker_spec.rb
+- spec/unit/virtus_group_spec.rb
+- virtus-group.gemspec
+homepage: https://github.com/spoptchev/virtus-group
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Define groups over virtus attributes.
+test_files:
+- spec/integration/virtus_group_integration_spec.rb
+- spec/spec_helper.rb
+- spec/unit/group/attribute_tracker_spec.rb
+- spec/unit/virtus_group_spec.rb