attribs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41d8896fb88e2a974780b53d830f1e1a59f89ec6
+  data.tar.gz: ab506e5dd05cf412fe6c2b47117251ef871da5ca
+SHA512:
+  metadata.gz: 8c6043299fe57754ebeca285fc1ab41100d3e01805a41126672f2d37151b0cbf3290aaf717a520ebb92e518668585ffacb3a4ea3538cd86a683691fa1ba391d9
+  data.tar.gz: 9d6e0984bc0e21bbda2b3555857163762f8d64c42a32e4307432aa3af3c71580fdb233550e7a5de4c352b3067c8efcc25199aa13df1cd4d2f669345ea74d4ce6

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 @@
+-r spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Arne Brasseur
+
+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,44 @@
+# Attribs
+
+Easy and flexible Ruby value objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attribs'
+```
+
+And then execute:
+
+    $ gem install -g
+
+
+Or install it directly:
+
+    $ gem install attribs
+
+## Usage
+
+``` ruby
+class Widget
+  include Attribs.new(:color, :size, quantity: 1)
+end
+
+w = Widget.new(color: 'blue', size: '10')
+w2 = w.with(color: 'red')
+puts w2.pp
+w.to_h
+```
+
+## Shoutout
+
+To [Anima](https://github.com/mbj/anima), which powers most of what
+Attribs offers.
+
+## License
+
+© 2014-2015 Arne Brasseur
+
+MIT License (see LICENSE.txt)

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems/package_task'
+
+spec = Gem::Specification.load(File.expand_path('../attribs.gemspec', __FILE__))
+gem = Gem::PackageTask.new(spec)
+gem.define
+
+desc "Push gem to rubygems.org"
+task :push => :gem do
+  sh "git tag v#{spec.version}"
+  sh "git push --tags"
+  sh "gem push pkg/attribs-#{spec.version}.gem"
+end
+
+require 'mutant'
+task :default => :mutant
+
+desc "run mutant"
+task :mutant do
+  pattern = ENV.fetch('PATTERN', 'Attribs*')
+  opts    = ENV.fetch('MUTANT_OPTS', '').split(' ')
+  result  = Mutant::CLI.run(%w[-Ilib -rattribs --use rspec --score 100] + opts + [pattern])
+  fail unless result == Mutant::CLI::EXIT_SUCCESS
+end
+
+require 'rspec/core/rake_task'
+
+desc "run rspec"
+RSpec::Core::RakeTask.new(:rspec) do |t, task_args|
+  t.rspec_opts = "-Ispec"
+  t.pattern = "spec"
+end

data/attribs.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name          = "attribs"
+  gem.version       = "1.0.0"
+  gem.authors       = ["Arne Brasseur"]
+  gem.email         = ["arne@arnebrasseur.net"]
+  gem.summary       = %q{Perfect Features Toggles}
+  gem.description   = %q{Multi-strategy feature flags.}
+  gem.homepage      = "https://github.com/plexus/attribs"
+  gem.license       = "MIT"
+
+  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.extra_rdoc_files = %w[README.md]
+
+  gem.add_runtime_dependency "anima", "~> 0.2.0"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 3.1"
+  gem.add_development_dependency "mutant-rspec"
+end

data/lib/attribs/instance_methods.rb

@@ -0,0 +1,54 @@
+class Attribs
+  module InstanceMethods
+    def initialize(attributes = {})
+      super(self.class.attributes.defaults.merge(attributes))
+    end
+
+    def with(attributes)
+      self.class.new(to_h.update(attributes))
+    end
+
+    def append_to(type, *objects)
+      with(type => instance_variable_get("@#{type}") + objects)
+    end
+
+    def to_h_compact
+      defaults = self.class.attributes.defaults
+      to_h.reject do |attr, value|
+        value.equal?(defaults[attr])
+      end
+    end
+
+    def pp
+      indent = ->(str) { str.lines.map {|l| "  #{l}"}.join }
+      format = ->(val) { val.respond_to?(:pp) ? val.pp : val.inspect }
+
+      values   = to_h_compact
+
+      fmt_attrs = values.map do |attr, value|
+        fmt_val = case value
+                  when Array
+                    if value.inspect.length < 50
+                      "[#{value.map(&format).join(", ")}]"
+                    else
+                      "[\n#{indent[value.map(&format).join(",\n")]}\n]"
+                    end
+                  else
+                    format[value]
+                  end
+        "#{attr}: #{fmt_val}"
+      end
+
+      fmt_attrs_str = fmt_attrs.join(", ")
+
+      if fmt_attrs_str.length > 50
+        fmt_attrs_str = fmt_attrs.join(",\n")
+      end
+
+      if fmt_attrs_str =~ /\n/
+        fmt_attrs_str = "\n#{indent[fmt_attrs_str]}\n"
+      end
+      "#{self.class.name}.new(#{fmt_attrs_str})"
+    end
+  end
+end

data/lib/attribs.rb

@@ -0,0 +1,30 @@
+require 'anima'
+
+class Attribs < Module
+  attr_reader :defaults, :names
+
+  def initialize(*attrs)
+    @defaults   = attrs.last.instance_of?(Hash) ? attrs.pop : {}
+    @names = (attrs + @defaults.keys).uniq
+  end
+
+  def add(*attrs)
+    defaults = attrs.last.instance_of?(Hash) ? attrs.pop : {}
+    self.class.new(*[*(names+attrs), @defaults.merge(defaults)])
+  end
+
+  def remove(*attrs)
+    self.class.new(*[*(names-attrs), @defaults.reject {|k| attrs.include?(k) }])
+  end
+
+  def included(descendant)
+    descendant.module_exec(self) do |this|
+      include InstanceMethods,
+              Anima.new(*this.names)
+
+      define_singleton_method(:attributes) { this }
+    end
+  end
+end
+
+require 'attribs/instance_methods'

data/spec/attribs_spec.rb

@@ -0,0 +1,234 @@
+RSpec.describe Attribs do
+  subject { Class.new.instance_exec(args) {|args| include Attribs.new(*args) } }
+  let(:args) { [:foo, bar: 3] }
+
+  let(:attributes_module) do
+    subject.included_modules.detect do |mod|
+      mod.instance_of?(described_class)
+    end
+  end
+
+  describe '#initialize' do
+    it 'should store defaults' do
+      expect(attributes_module.defaults).to eql(bar: 3)
+    end
+
+    it 'should store attribute names' do
+      expect(attributes_module.names).to eql [:foo, :bar]
+    end
+
+    context 'without defaults' do
+      let(:args) { [:foo, :bar] }
+
+      it 'should have no defaults' do
+        expect(attributes_module.defaults).to eql({})
+      end
+    end
+
+    context 'with a name given both with and without default' do
+      let(:args) { [:foo, foo: 3] }
+
+      it 'should only store the name once' do
+        expect(attributes_module.names).to eql([:foo])
+      end
+    end
+  end
+
+  describe '#included' do
+    it 'should have a hash-based constructor' do
+      expect(subject.new(foo: 3, bar: 4).bar).to equal 4
+    end
+
+    it 'should have defaults constructor' do
+      expect(subject.new(foo: 3).bar).to equal 3
+    end
+
+    it 'should allow updating through with' do
+      expect(subject.new(foo: 3).with(foo: 4).to_h).to eql(foo: 4, bar: 3)
+    end
+
+    it 'should add an #append_to method' do
+      expect(subject.new(foo: [6]).append_to(:foo, 7, 8).foo).to eql [6, 7, 8]
+    end
+
+    context 'with all defaults' do
+      subject { Class.new { include Attribs.new(foo: 5, bar: 3) } }
+
+      it 'should be able to construct without arguments' do
+        expect(subject.new.to_h).to eql(foo: 5, bar: 3)
+      end
+    end
+
+    context 'without any defaults' do
+      subject { Class.new { include Attribs.new(:foo, :bar) } }
+
+      it 'should allow setting all attributes' do
+        expect(subject.new(foo: 5, bar: 6).bar).to equal 6
+      end
+
+      it 'should expect all attributes' do
+        expect { subject.new(foo: 5) }.to raise_exception
+      end
+    end
+  end
+
+  describe '#add' do
+    subject { Class.new(super()) { include attributes.add(baz: 7, bar: 4) } }
+
+    it 'should make the new attributes available' do
+      expect(subject.new(foo: 3, baz: 6).baz).to equal 6
+    end
+
+    it 'should make the old attributes available' do
+      expect(subject.new(foo: 3, baz: 6).foo).to equal 3
+    end
+
+    it 'should take new default values' do
+      expect(subject.new(foo: 3, baz: 6).bar).to equal 4
+    end
+
+    it 'should make sure attribute names are uniq' do
+      expect(subject.attributes.names.length).to equal 3
+    end
+
+    context 'without any defaults' do
+      subject { Class.new(super()) { include attributes.add(:bax) } }
+
+      it 'should allow setting all attributes' do
+        expect(subject.new(foo: 5, bar: 6, bax: 7).bax).to equal 7
+      end
+
+      it 'should expect all attributes' do
+        expect { subject.new(foo: 5, bar: 6) }.to raise_exception
+      end
+    end
+  end
+
+  describe '#remove' do
+    context 'when removing an attribute with a default' do
+      subject { Class.new(super()) { include attributes.remove(:bar) } }
+
+      it 'should still recognize attributes that were kept' do
+        expect(subject.new(foo: 2).foo).to equal 2
+      end
+
+      it 'should no longer recognize the old attributes' do
+        expect { subject.new(foo: 3, bar: 3).bar }.to raise_error
+      end
+    end
+
+    context 'when removing an attribute without a default' do
+      subject { Class.new(super()) { include attributes.remove(:foo) } }
+
+      it 'should still recognize attributes that were kept' do
+        expect(subject.new(bar: 2).bar).to equal 2
+      end
+
+      it 'should no longer recognize the old attributes' do
+        expect { subject.new(foo: 3).foo }.to raise_error
+      end
+
+      it 'should keep the defaults' do
+        expect(subject.new.bar).to equal 3
+      end
+    end
+  end
+end
+
+RSpec.describe Attribs::InstanceMethods do
+  let(:widget) do
+    Class.new do
+      include Attribs.new(:color, :size, options: {})
+      def self.name ; 'Widget' ; end
+    end
+  end
+
+  let(:widget_container) do
+    Class.new do
+      include Attribs.new(widgets: [])
+      def self.name ; 'WidgetContainer' ; end
+    end
+  end
+
+  let(:fixed_width) do
+    Class.new do
+      def initialize(width)
+        @width = width
+      end
+
+      def inspect
+        "#" * @width
+      end
+    end
+  end
+
+  describe '#pp' do
+    it 'should render correctly' do
+      expect(widget_container.new(widgets: [
+                                    widget.new(color: :green, size: 7),
+                                    widget.new(color: :blue, size: 9, options: {foo: :bar})
+                                  ]).pp).to eql "
+WidgetContainer.new(
+  widgets: [
+    Widget.new(color: :green, size: 7),
+    Widget.new(color: :blue, size: 9, options: {:foo=>:bar})
+  ]
+)
+".strip
+    end
+
+    it 'should inline short arrays' do
+      expect(widget_container.new(widgets: [
+                                    fixed_width.new(23),
+                                    fixed_width.new(22)
+                                  ]).pp).to eql "WidgetContainer.new(widgets: [#######################, ######################])"
+    end
+
+    it 'should put longer arrays on multiple lines' do
+      expect(widget_container.new(widgets: [
+                                    fixed_width.new(23),
+                                    fixed_width.new(23)
+                                  ]).pp).to eql "WidgetContainer.new(\n  widgets: [\n    #######################,\n    #######################\n  ]\n)"
+    end
+
+    it 'should puts attributes on multiple lines if total length exceeds 50 chars' do
+      expect(widget.new(color: fixed_width.new(18), size: fixed_width.new(18)).pp).to match /\n/
+      expect(widget.new(color: fixed_width.new(18), size: fixed_width.new(17)).pp).to_not match /\n/
+    end
+  end
+
+  describe '#append_to' do
+    it 'should append to a named collection' do
+      expect(widget_container.new(widgets: [:bar]).append_to(:widgets, :foo)).to eql widget_container.new(widgets: [:bar, :foo])
+    end
+  end
+
+  describe '#initialize' do
+    it 'should take hash-based args' do
+      expect(widget_container.new(widgets: [:bar])).to eql widget_container.new.with(widgets: [:bar])
+    end
+
+    it 'should use defaults when available' do
+      expect(widget.new(color: :blue, size: 3).options).to eql({})
+    end
+  end
+
+  describe '#to_h_compact' do
+    it 'should not show values that are identical to the defaults' do
+      expect(widget.new(color: :red, size: 7).to_h_compact)
+        .to eql({color: :red, size: 7})
+    end
+
+    it 'should include values that are equivalent but not identical' do
+      expect(widget.new(color: :red, size: 7, options: {}).to_h_compact)
+        .to eql({color: :red, size: 7, options: {}})
+    end
+  end
+
+  describe '#with' do
+    it 'should update specific attributes' do
+      expect(widget.new(color: :red, size: 7).with(color: :blue))
+        .to eql(widget.new(color: :blue, size: 7))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'attribs'
+
+RSpec.configure do |rspec|
+  rspec.disable_monkey_patching!
+  rspec.raise_errors_for_deprecations!
+  rspec.around(:each) do |example|
+    Timeout.timeout(1, &example)
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: attribs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arne Brasseur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anima
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.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: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mutant-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: Multi-strategy feature flags.
+email:
+- arne@arnebrasseur.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attribs.gemspec
+- lib/attribs.rb
+- lib/attribs/instance_methods.rb
+- spec/attribs_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/plexus/attribs
+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.6
+signing_key: 
+specification_version: 4
+summary: Perfect Features Toggles
+test_files:
+- spec/attribs_spec.rb
+- spec/spec_helper.rb