immutable-struct 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 90315cc7aa75a487cf037aefed966ae52c2a1826
-  data.tar.gz: 6f6c1750a942a9ab4ec45fa015fb0f75c03d3036
+SHA256:
+  metadata.gz: 79b8217337e96a8a7514ea7cfef14f75176fe8468dd552d0c523f934483d5080
+  data.tar.gz: b7517bc4e1ae43423a4483d2fa42a4913710453fc00a17cab37bc78ee6b83d33
 SHA512:
-  metadata.gz: bf5c63f1f22ccd08744d02ae6afa583bbd901df66fdb8f68798d7b689bb3c54f487f7279f877f9525c03e98eec824d667d27769e37a828b87f279a4421a2e602
-  data.tar.gz: 22507c2b9558426d29574c7aa8d1206894a1b9d00d5c89f679765b5ac89c42f9b40425967afe831b71362f6c684db5c14b7eea3657d10296594cf07cc6553cd1
+  metadata.gz: dba93bcdabd6fdcaaa137ad6c3b20ab379ecc64128aa19f5ae796e13ef9d04d0a66c9fa2becef11bbee15488793b7ebad3c8c42047f541b1226284ff02f78c44
+  data.tar.gz: 1478ce402dea03830755e8b28393683c7da8a308247c7db39d0856c0eb95e4e56276fc3926ab3b469bf9a4a4f07b9435951535b3e91498e6a0f1960714e5c801

data/.circleci/config.yml

@@ -0,0 +1,64 @@
+# DO NOT MODIFY - this is managed by Git Reduce in goro
+#
+---
+version: 2
+jobs:
+  ruby-2.6.1:
+    docker:
+    - image: circleci/ruby:2.6.1
+    working_directory: "~/immutable-struct"
+    steps:
+    - checkout
+    - run: bundle install --full-index
+    - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
+        --format=doc
+    - run:
+        name: Run Additional CI Steps
+        command: if [ -e bin/additional-ci-steps ]; then bin/additional-ci-steps;
+          fi
+    - run:
+        name: Notify Pager Duty
+        command: 'bundle exec y-notify #eng-platform'
+        when: on_fail
+    - store_test_results:
+        path: "/tmp/test-results"
+  ruby-2.5.3:
+    docker:
+    - image: circleci/ruby:2.5.3
+    working_directory: "~/immutable-struct"
+    steps:
+    - checkout
+    - run: bundle install --full-index
+    - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
+        --format=doc
+    - run:
+        name: Run Additional CI Steps
+        command: if [ -e bin/additional-ci-steps ]; then bin/additional-ci-steps;
+          fi
+    - run:
+        name: Notify Pager Duty
+        command: 'bundle exec y-notify #eng-platform'
+        when: on_fail
+    - store_test_results:
+        path: "/tmp/test-results"
+workflows:
+  version: 2
+  on-commit:
+    jobs:
+    - ruby-2.6.1:
+        context: org-global
+    - ruby-2.5.3:
+        context: org-global
+  scheduled:
+    triggers:
+    - schedule:
+        cron: 4 21 * * 1,2,3,4,5
+        filters:
+          branches:
+            only:
+            - master
+    jobs:
+    - ruby-2.6.1:
+        context: org-global
+    - ruby-2.5.3:
+        context: org-global

data/.gitignore

@@ -16,3 +16,4 @@ test/version_tmp
 tmp
 html
 .*.sw?
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.5.3

data/.travis.yml

@@ -2,8 +2,7 @@ language: ruby
 before_install:
   - gem install bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.2
+  - 2.5.0
+  - 2.4.3
+  - 2.3.6
   - ruby-head

data/README.rdoc

@@ -56,7 +56,17 @@ If not using bundler, just use RubyGems:
     new_person.name    # => "Other Dave"
     new_person.age     # => 41
     new_person.active? # => true
-    
+
+You can coerce values into struct types by using the +from+ method.
+This is similar to Ruby's conversion functions, e.g. Integer("1").
+
+    dave = Person.from(p)
+    dave.equal?(p) # => true (object equality)
+
+    daveish = Person.from(dave.to_h)
+    daveish.equal?(dave) # => false
+    daveish == dave      # => true
+
 You can treat the interior of the block as a normal class definition with the exception of setting constants.
 Use +const_set+ to scope constants as-expected.
 
@@ -66,7 +76,7 @@ Use +const_set+ to scope constants as-expected.
     end
     Point::ZERO # => 0
     ::ONE_HUNDRED # => 100
-    ::ZERO # => NameError: uninitialized constant ZERO    
+    ::ZERO # => NameError: uninitialized constant ZERO
 
 
 == Links

data/build-matrix.json

@@ -0,0 +1,4 @@
+{
+  "build_matrix": {
+  }
+}

data/immutable-struct.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency('rspec_junit_formatter')
 end

data/lib/immutable-struct.rb

@@ -6,7 +6,7 @@
 # will be evaluated as if it were inside a class definition, allowing you
 # to add methods, include or extend modules, or do whatever else you want.
 class ImmutableStruct
-  VERSION='2.3.0' #:nodoc:
+  VERSION='2.4.0' #:nodoc:
   # Create a new class with the given read-only attributes.
   #
   # attributes:: list of symbols or strings that can be used to create attributes.
@@ -72,6 +72,15 @@ class ImmutableStruct
         end
       end
 
+      define_singleton_method(:from) do |value|
+        case value
+        when self then value
+        when Hash then new(value)
+        else
+          raise ArgumentError, "cannot coerce #{value.class} #{value.inspect} into #{self}"
+        end
+      end
+
       define_method(:initialize) do |*args|
         attrs = args[0] || {}
         attributes.each do |attribute|

data/owners.json

@@ -0,0 +1,7 @@
+{
+  "owners": [
+    {
+      "team": "platform"
+    }
+  ]
+}

data/spec/immutable_struct_spec.rb

@@ -13,31 +13,30 @@ describe ImmutableStruct do
       end
       subject { @klass.new }
 
-      it { should     respond_to(:foo) }
-      it { should     respond_to(:bar) }
-      it { should     respond_to(:baz) }
-      it { should_not respond_to(:foo=) }
-      it { should_not respond_to(:bar=) }
-      it { should_not respond_to(:baz=) }
-      it { should_not respond_to(:foo?) }
-      it { should_not respond_to(:bar?) }
-      it { should_not respond_to(:baz?) }
+      it { is_expected.to     respond_to(:foo) }
+      it { is_expected.to     respond_to(:bar) }
+      it { is_expected.to     respond_to(:baz) }
+      it { is_expected.not_to respond_to(:foo=) }
+      it { is_expected.not_to respond_to(:bar=) }
+      it { is_expected.not_to respond_to(:baz=) }
+      it { is_expected.not_to respond_to(:foo?) }
+      it { is_expected.not_to respond_to(:bar?) }
+      it { is_expected.not_to respond_to(:baz?) }
 
       context "instances can be created with a hash" do
-
         context 'with symbol keys' do
           subject { @klass.new(foo: "FOO", bar: 42, baz: [:a,:b,:c]) }
 
-          it { subject.foo.should == "FOO" }
-          it { subject.bar.should == 42 }
-          it { subject.baz.should == [:a,:b,:c] }
+          it { expect(subject.foo).to eq("FOO") }
+          it { expect(subject.bar).to eq(42) }
+          it { expect(subject.baz).to eq([:a,:b,:c]) }
         end
 
         context "with string keys" do
           subject { ImmutableStruct.new(:foo) }
 
-          it { subject.new('foo' => true).foo.should == true }
-          it { subject.new('foo' => false).foo.should == false }
+          it { expect(subject.new('foo' => true).foo).to eq(true) }
+          it { expect(subject.new('foo' => false).foo).to eq(false) }
         end
       end
     end
@@ -46,20 +45,20 @@ describe ImmutableStruct do
       subject { ImmutableStruct.new(:foo?) }
 
       context "with boolean values" do
-        it { subject.new(foo: false).foo?.should == false }
-        it { subject.new(foo: false).foo.should == false }
-        it { subject.new(foo: true).foo?.should == true }
-        it { subject.new(foo: true).foo.should == true }
+        it { expect(subject.new(foo: false).foo?).to eq(false) }
+        it { expect(subject.new(foo: false).foo).to eq(false) }
+        it { expect(subject.new(foo: true).foo?).to eq(true) }
+        it { expect(subject.new(foo: true).foo).to eq(true) }
       end
 
       context "with falsey, non-boolean values" do
-        it { subject.new.foo?.should == false }
-        it { subject.new.foo.should == nil }
+        it { expect(subject.new.foo?).to eq(false) }
+        it { expect(subject.new.foo).to eq(nil) }
       end
 
       context "with truthy, non-boolean values" do
-        it { subject.new(foo: "true").foo?.should == true }
-        it { subject.new(foo: "true").foo.should == "true" }
+        it { expect(subject.new(foo: "true").foo?).to eq(true) }
+        it { expect(subject.new(foo: "true").foo).to eq("true") }
       end
     end
 
@@ -67,8 +66,8 @@ describe ImmutableStruct do
       it "can define an array value that should never be nil" do
         klass = ImmutableStruct.new([:foo], :bar)
         instance = klass.new
-        instance.foo.should == []
-        instance.bar.should == nil
+        expect(instance.foo).to eq([])
+        expect(instance.bar).to eq(nil)
       end
     end
 
@@ -77,7 +76,7 @@ describe ImmutableStruct do
         def derived; self.foo + ":" + self.bar; end
       end
       instance = klass.new(foo: "hello", bar: "world")
-      instance.derived.should == "hello:world"
+      expect(instance.derived).to eq("hello:world")
     end
 
     it "allows defining class methods" do
@@ -87,8 +86,8 @@ describe ImmutableStruct do
         end
       end
       instance = klass.from_array(["hello","world"])
-      instance.foo.should == "hello"
-      instance.bar.should == "world"
+      expect(instance.foo).to eq("hello")
+      expect(instance.bar).to eq("world")
     end
 
     it "allows module inclusion" do
@@ -97,8 +96,8 @@ describe ImmutableStruct do
       end
       instance = klass.new
 
-      instance.should  respond_to(:hello)
-      klass.should_not respond_to(:hello)
+      expect(instance).to  respond_to(:hello)
+      expect(klass).not_to respond_to(:hello)
     end
 
     it "allows module extension" do
@@ -107,8 +106,28 @@ describe ImmutableStruct do
       end
       instance = klass.new
 
-      instance.should_not respond_to(:hello)
-      klass.should        respond_to(:hello)
+      expect(instance).not_to respond_to(:hello)
+      expect(klass).to        respond_to(:hello)
+    end
+  end
+
+  describe "coercion" do
+    let(:klass) { ImmutableStruct.new(:lolwat) }
+
+    it "is a noop when value is already the defined type" do
+      value = klass.new
+      new_value = klass.from(value)
+      expect(new_value).to be(value)
+    end
+
+    it "initializes a new value when Hash is given" do
+      value = klass.from(lolwat: "haha")
+      expect(value.lolwat).to eq("haha")
+    end
+
+    it "errors when value cannot be coerced" do
+      expect { klass.from(Object.new) }
+        .to raise_error(ArgumentError)
     end
   end
 
@@ -121,16 +140,17 @@ describe ImmutableStruct do
           end
         end
         instance = klass.new(name: "Rudy", minor: "ayup", aliases: [ "Rudyard", "Roozoola" ])
-        instance.to_h.should == {
+        expect(instance.to_h).to eq({
           name: "Rudy",
           minor: "ayup",
           minor?: true,
           location: nil,
           aliases: [ "Rudyard", "Roozoola"],
           nick_name: "bob",
-        }
+        })
       end
     end
+
     context "additional method that takes arguments" do
       it "should not call the additional method" do
         klass = ImmutableStruct.new(:name, :minor?, :location, [:aliases]) do
@@ -142,16 +162,17 @@ describe ImmutableStruct do
           end
         end
         instance = klass.new(name: "Rudy", minor: "ayup", aliases: [ "Rudyard", "Roozoola" ])
-        instance.to_h.should == {
+        expect(instance.to_h).to eq({
           name: "Rudy",
           minor: "ayup",
           minor?: true,
           location: nil,
           aliases: [ "Rudyard", "Roozoola"],
           nick_name: "bob",
-        }
+        })
       end
     end
+
     context "to_hash is its alias" do
       it "is identical" do
         klass = ImmutableStruct.new(:name, :minor?, :location, [:aliases]) do
@@ -163,24 +184,7 @@ describe ImmutableStruct do
           end
         end
         instance = klass.new(name: "Rudy", minor: "ayup", aliases: [ "Rudyard", "Roozoola" ])
-        instance.to_h.should == instance.to_hash
-      end
-    end
-
-    context "no-arg method that uses to_h" do
-      it "blows up" do
-        klass = ImmutableStruct.new(:name, :minor?, :location, [:aliases]) do
-          def nick_name
-            'bob'
-          end
-          def to_json
-            to_h.to_json
-          end
-        end
-        instance = klass.new(name: "Rudy", minor: "ayup", aliases: [ "Rudyard", "Roozoola" ])
-        expect {
-          instance.to_json.should == instance.to_h.to_json
-        }.to raise_error(SystemStackError)
+        expect(instance.to_h).to eq(instance.to_hash)
       end
     end
   end
@@ -191,20 +195,19 @@ describe ImmutableStruct do
       instance = klass.new(food: 'hot dogs', butter: true)
       new_instance = instance.merge(snacks: 'candy hot dogs', butter: false)
 
-      instance.food.should == 'hot dogs'
-      instance.butter.should == true
-      instance.snacks.should == nil
+      expect(instance.food).to eq('hot dogs')
+      expect(instance.butter).to eq(true)
+      expect(instance.snacks).to eq(nil)
 
-      new_instance.food.should == 'hot dogs'
-      new_instance.snacks.should == 'candy hot dogs'
-      new_instance.butter.should == false
+      expect(new_instance.food).to eq('hot dogs')
+      expect(new_instance.snacks).to eq('candy hot dogs')
+      expect(new_instance.butter).to eq(false)
 
-      new_instance.object_id.should_not == instance.object_id
+      expect(new_instance.object_id).not_to eq(instance.object_id)
     end
   end
 
   describe "equality" do
-
     before do
       klass_1 = ImmutableStruct.new(:foo, [:bars])
       klass_2 = ImmutableStruct.new(:foo, [:bars])
@@ -215,84 +218,77 @@ describe ImmutableStruct do
     end
 
     describe "==" do
-
       it "should be equal to itself" do
-        (@k1_a == @k1_a).should be true
+        expect(@k1_a == @k1_a).to be true
       end
 
       it "should be equal to same class with identical attribute values" do
-        (@k1_a == @k1_c).should be true
+        expect(@k1_a == @k1_c).to be true
       end
 
       it 'should not be equal to same class with different attribute values' do
-        (@k1_a == @k1_b).should be false
+        expect(@k1_a == @k1_b).to be false
       end
 
       it 'should not be equal to different class with identical attribute values' do
-        (@k1_a == @k3_a).should be false
+        expect(@k1_a == @k3_a).to be false
       end
-
     end
 
     describe "eql?" do
-
       it "should be equal to itself" do
-        @k1_a.eql?(@k1_a).should be true
+        expect(@k1_a.eql?(@k1_a)).to be true
       end
 
       it "should be equal to same class with identical attribute values" do
-        @k1_a.eql?(@k1_c).should be true
+        expect(@k1_a.eql?(@k1_c)).to be true
       end
 
       it 'should not be equal to same class with different attribute values' do
-        @k1_a.eql?(@k1_b).should be false
+        expect(@k1_a.eql?(@k1_b)).to be false
       end
 
       it 'should not be equal to different class with identical attribute values' do
-        @k1_a.eql?(@k3_a).should be false
+        expect(@k1_a.eql?(@k3_a)).to be false
       end
-
     end
 
     describe "hash" do
-
       it "should have same hash value as itself" do
-        @k1_a.hash.eql?(@k1_a.hash).should be true
+        expect(@k1_a.hash.eql?(@k1_a.hash)).to be true
       end
 
       it "should have same hash value as same class with identical attribute values" do
-        @k1_a.hash.eql?(@k1_c.hash).should be true
+        expect(@k1_a.hash.eql?(@k1_c.hash)).to be true
       end
 
       it 'should not have hash value as same class with different attribute values' do
-        @k1_a.hash.eql?(@k1_b.hash).should be false
+        expect(@k1_a.hash.eql?(@k1_b.hash)).to be false
       end
 
       it 'should not have hash value equal to different class with identical attribute values' do
-        @k1_a.hash.eql?(@k3_a.hash).should be false
+        expect(@k1_a.hash.eql?(@k3_a.hash)).to be false
       end
 
       it 'should reject set addition if same instance is already a member' do
         set = Set.new([@k1_a])
-        set.add?(@k1_a).should be nil
+        expect(set.add?(@k1_a)).to be nil
       end
 
       it 'should reject set addition if different instance, but attributes are the same' do
         set = Set.new([@k1_a])
-        set.add?(@k1_c).should be nil
+        expect(set.add?(@k1_c)).to be nil
       end
 
       it 'should allow set addition if different instance and attribute values' do
         set = Set.new([@k1_a])
-        set.add?(@k1_b).should_not be nil
+        expect(set.add?(@k1_b)).not_to be nil
       end
 
       it 'should allow set addition if different class' do
         set = Set.new([@k1_a])
-        set.add?(@k2_a).should_not be nil
+        expect(set.add?(@k2_a)).not_to be nil
       end
-
     end
-
   end
 end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ require 'immutable-struct'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
-    c.syntax = [:should, :expect]
+    c.syntax = [:expect]
   end
   config.order = "random"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immutable-struct
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -10,20 +10,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   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
@@ -54,6 +54,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: Easily create value objects without the pain of Ruby's Struct (or its
   setters)
 email:
@@ -64,6 +78,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -71,12 +86,13 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- build-matrix.json
 - immutable-struct.gemspec
 - lib/immutable-struct.rb
+- owners.json
 - spec/immutable_struct_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/stitchfix/immutable-struct
@@ -98,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Easily create value objects without the pain of Ruby's Struct (or its setters)

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    immutable-struct (2.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    rake (11.2.2)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.3)
-  immutable-struct!
-  rake
-  rspec
-
-BUNDLED WITH
-   1.14.6