collectable 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTE4ODA2MDhmMmViYWE5YzU2MTkyMTRlYWI5ZGViYjI4ZTMxY2ZjOA==
+  data.tar.gz: !binary |-
+    YjVhMzBiODc0ZDEwM2UxMjMxZDYzYzE0Njk0ZmVhOGVkM2E0MDJjYw==
+SHA512:
+  metadata.gz: !binary |-
+    MDkxMGFlNTNkOTVhZmZmYjI0MzdmOGU1NjYyMGE5MGY2ZTQwMmRmZThiNzQw
+    NmRiMGQyNzhmZTZlNTg1MzY3YWE5MTUxNGM5MzIzNzEyMzYzM2MwOGVlNzY3
+    MmZiOGY1ZTc3MmY3MzZkM2E4NDViYWZjNmNjMTY1MzMyMWNlYjM=
+  data.tar.gz: !binary |-
+    MTFiODQ4NGFmYjE5NGYyNGZiYTI2ZTQ5ZjAzNTFjMDA0NmM1MGFiM2E3Yjc0
+    YmVmNGI2ODA4NDE5ODFiODliMDRmYTIwNWYxZjQ4YTEyMzJmYTI3NjVjMDFl
+    MTNkYTY2NDM4NGI3YTI1ZmQzNGQxNWE1YTcxMTRlMDY0NjIzNTQ=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Dennis Walters
+
+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,62 @@
+## Collectable ##
+
+So, I serialize stuff into arrays in my AR objects where it doesn't make
+sense to go through the rigamaroe of actually making an empty AR model
+to use for the association. This is just a bit of glue to make using
+that pattern a bit easier with 
+
+There's not much to this thing, and what's there exists only to serve the
+needs that I've had for this sort of thing.
+
+That said, pull requests are totally welcome :)
+
+## Gem Setup ##
+
+```ruby
+gem install collectable
+
+# Gemfile
+gem 'collectable'
+```
+## Basic usage ##
+
+The short version is "include the module and define some traits." That's also
+the long version, as it were.
+
+```ruby
+class HairColor
+  include Collectable
+
+  trait :blonde
+  trait :brown
+  trait :red
+  trait :black
+  trait :purple
+  trait :tie_dye
+end
+```
+
+Then, to actually use the thing, do something like this in your view:
+
+```erb
+<%= form_for @person do |f| %>
+  <%= f.collection_check_boxes(:hair_color, HairColor.collected, HairColor.value, HairColor.name) %>
+<% end %>
+```
+
+## Contributing ##
+
+Do you use git-flow? I sure do. Please base anything you do off of
+[the develop branch](https://github.com/ess/absolution/tree/develop).
+
+1. Fork it.
+2. Perform some BDD magic. Seriously. Be testing.
+3. Submit a pull request.
+
+## History ##
+
+* 0.0.1 - Public release
+
+## License ##
+
+MIT License. Copyright 2014 Dennis Walters

data/lib/collectable/version.rb

@@ -0,0 +1,3 @@
+module Collectable
+  VERSION = '0.0.1'
+end

data/lib/collectable.rb

@@ -0,0 +1,26 @@
+require 'ostruct'
+
+module Collectable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def traits
+      @traits ||= []
+    end
+
+    def trait(trait_name)
+      traits.push(trait_name.to_s.downcase)
+      traits.uniq!
+    end
+
+    def collected(sort_field = :name)
+      traits.each_with_index.map {|name, index|
+        OpenStruct.new(name: name, val: index)
+      }.sort {|a,b| 
+        a.send(sort_field) <=> b.send(sort_field)
+      }
+    end
+  end
+end

data/spec/collectable_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'collectable'
+
+class Dummy
+  include Collectable
+end
+
+class TraitDummy
+  include Collectable
+end
+
+class TraitsDummy
+  include Collectable
+end
+
+class CollectedDummy
+  include Collectable
+end
+
+describe Collectable do
+  let(:klass) {Collectable}
+
+  context 'when included' do
+    let(:dummy) {Dummy}
+
+    it 'knows how to define traits' do
+      expect(dummy).to respond_to(:trait)
+    end
+
+    it 'can report its tratis' do
+      expect(dummy).to respond_to(:traits)
+    end
+
+    it 'knows how to collect the traits' do
+      expect(dummy).to respond_to(:collected)
+    end
+  end
+
+  describe '.trait' do
+    let(:trait_dummy) {
+      TraitDummy
+    }
+
+    it 'can take a symbol' do
+      expect {trait_dummy.trait :Blah}.not_to raise_error
+    end
+
+    it 'can take a string' do
+      expect {trait_dummy.trait 'Trait 2'}.not_to raise_error
+    end
+
+    it 'adds a trait to the collectable traits' do
+      new_trait = :New_Trait
+      trait_dummy.trait new_trait
+      expect(trait_dummy.traits).to include(new_trait.to_s.downcase)
+    end
+  end
+
+  describe '.traits' do
+    let(:traits_dummy) {
+      TraitsDummy
+    }
+
+    let(:new_trait) {:new_trait}
+
+    it 'is an array' do
+      expect(traits_dummy.traits).to be_a(Array)
+    end
+
+    it 'contains the traits defined by the class' do
+      expect(traits_dummy.traits).to be_empty
+
+      traits_dummy.trait new_trait
+      expect(traits_dummy.traits).to include(new_trait.to_s.downcase)
+    end
+  end
+
+  describe '.collected' do
+    let(:collected_dummy) {
+      CollectedDummy
+    }
+
+    it 'is an array' do
+      expect(collected_dummy.collected).to be_a(Array)
+    end
+
+    it 'contains OpenStruct representations of the known traits' do
+      collected_dummy.trait :trait_1
+      collected_dummy.trait :trait_2
+
+      expect(collected_dummy.collected.map(&:name)).
+        to eql(collected_dummy.traits.sort)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'rspec/mocks'
+require 'rspec/expectations'
+
+$:.unshift File.join(File.dirname(__FILE__), '..')
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: collectable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-10 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Make PORO models work with collection_check_boxes
+email:
+- pooster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/collectable/version.rb
+- lib/collectable.rb
+- MIT-LICENSE
+- README.md
+- spec/collectable_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ess/collectable
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Make PORO models work with collection_check_boxes
+test_files:
+- spec/collectable_spec.rb
+- spec/spec_helper.rb