finer_struct 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e04806147484f9a88c442aeae1b5d916ab32ec5e
-  data.tar.gz: f3897c599510a3e49b79d9269b9fc4189b6ca69e
+  metadata.gz: 80dfaa74d9276f522ca1cf4e39175f42b8e679bc
+  data.tar.gz: 78595752aa946668b311fced58235745a0d0025e
 SHA512:
-  metadata.gz: 3299f59235ac4f062bd14d422ceb6a3558fd81946d9f53500f88b47e63528630184090e6cd605f76abef079b40263e82989814b74545daec1b0189d3cd00ba80
-  data.tar.gz: dc8f6fa1d98584317d1f4a069043d6c156daa03ae46b78ef321d4988e281833a8bed8ea7cd5d9c67ee70bf168f5dd0a2ed28e661b8e5509296f2ccb7b3f58346
+  metadata.gz: ef9af062326f3afb4bd18b9fd20eaea8472ef7062518eaf010a8616b0e9f77742c4bcc1f1a68e36e6cdd63940642371e403cac86f9b8aa79d950b3f3b2c861c4
+  data.tar.gz: 1d8d5dbb7c2ffbb279e92dfe829d7c598ad3d878b259bbd8514ac8b973ed30095287c0e820fae5bc391f05855714461d14c9c27b270f42ace0301ad72212fb46

data/Gemfile

@@ -1,5 +1,4 @@
-#source 'https://rubygems.org'
-source 'http://rubygems.railscamp.org'
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in finer_struct.gemspec
 gemspec

data/README.md

@@ -2,7 +2,7 @@
 
 A nicer replacement for Ruby's Struct and OpenStruct.
 
-Isn't it annoying how `OpenStruct.new` takes a hash, but the the arguments to `Struct.new` have to be ordered?
+Isn't it annoying how `OpenStruct.new` takes a hash, but the arguments to `Struct.new` have to be ordered?
 
 Do you find you always use an `OpenStruct` when you don't really care if it's open, you just want an easy way to create an object from a hash?
 
@@ -16,15 +16,21 @@ Have you ever wished you could create a `Struct` or `OpenStruct`, but make it im
 
 Add this line to your application's Gemfile:
 
-    gem 'finer_struct'
+```ruby
+gem 'finer_struct'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install finer_struct
+```bash
+$ gem install finer_struct
+```
 
 ## Usage
 
@@ -34,18 +40,22 @@ Immutable structs can't have their attributes changed after creation.
 
 #### Anonymous immutable structs
 
-    struct = FinerStruct::Immutable.new(a: 1, b: 2)
+```ruby
+struct = FinerStruct::Immutable.new(a: 1, b: 2)
 
-    struct.a # => 1
-    struct.b # => 2
-    struct.a = 3 # Exception!
+struct.a # => 1
+struct.b # => 2
+struct.a = 3 # Exception!
+```
 
 #### Named immutable structs
 
-    class MyStruct < FinerStruct::Immutable(:a, :b); end
-    struct = MyStruct.new(a: 1, b: 2)
+```ruby
+class MyStruct < FinerStruct::Immutable(:a, :b); end
+struct = MyStruct.new(a: 1, b: 2)
 
-    MyStruct.new(a: 1, b: 2, c: 3) # Exception!
+MyStruct.new(a: 1, b: 2, c: 3) # Exception!
+```
 
 ### Mutable Structs
 
@@ -53,15 +63,19 @@ Mutable structs let you assign attributes at any time.
 
 #### Anonymous mutable structs
 
-    struct = FinerStruct::Mutable.new(a: 1, b: 2)
+```ruby
+struct = FinerStruct::Mutable.new(a: 1, b: 2)
 
-    struct.a = 3
-    struct.a # => 3
+struct.a = 3
+struct.a # => 3
+```
 
 #### Named mutable structs
 
-    class MyStruct < FinerStruct::Mutable(:a, :b); end
-    struct = MyStruct.new(a: 1, b: 2)
+```ruby
+class MyStruct < FinerStruct::Mutable(:a, :b); end
+struct = MyStruct.new(a: 1, b: 2)
+```
 
 ## Contributing
 

data/lib/finer_struct/immutable.rb

@@ -15,17 +15,18 @@ module FinerStruct
         super
       end
     end
-  end
 
-  def self.Immutable(*attribute_names)
-    Named.build_class(attribute_names) do
-      attr_reader(*attribute_names)
+    def respond_to?(method)
+      @attributes.has_key?(method) || super
+    end
 
-      def initialize(*)
-        super
-        freeze
-      end
+    def to_hash
+      @attributes
     end
   end
 
+  def self.Immutable(*attribute_names)
+    Named.build_class(Immutable, attribute_names)
+  end
+
 end

data/lib/finer_struct/mutable.rb

@@ -18,6 +18,14 @@ module FinerStruct
       end
     end
 
+    def respond_to?(method)
+      @attributes.has_key?(method) || super
+    end
+
+    def to_hash
+      @attributes.dup
+    end
+
   private
 
     def is_assigment?(method)
@@ -30,9 +38,7 @@ module FinerStruct
   end
 
   def self.Mutable(*attribute_names)
-    Named.build_class(attribute_names) do
-      attr_accessor(*attribute_names)
-    end
+    Named.build_class(Mutable, attribute_names)
   end
 
 end

data/lib/finer_struct/named.rb

@@ -3,21 +3,19 @@ module FinerStruct
   module Named
 
     def initialize(attributes = {})
-      attributes.each_pair do |name, value|
-        unless attribute_names.include?(name)
-          raise(ArgumentError, "no such attribute: #{name}")
-        end
-        instance_variable_set("@#{name}", value)
+      unknown_attributes = attributes.keys - attribute_names
+      unless unknown_attributes.empty?
+        raise(ArgumentError, "unknown attributes: #{unknown_attributes.join(', ')}")
       end
+
+      super(attributes)
     end
 
-    def self.build_class(attribute_names, &block)
-      Class.new do
+    def self.build_class(superclass, attribute_names)
+      Class.new(superclass) do
         define_method(:attribute_names, -> { attribute_names })
 
         include Named
-
-        class_eval(&block)
       end
     end
   end

data/lib/finer_struct/version.rb

@@ -1,3 +1,3 @@
 module FinerStruct
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/finer_struct/immutable_spec.rb

@@ -9,7 +9,11 @@ shared_examples "an immutable struct" do
   end
 
   it "is frozen" do
-    subject.should be_frozen
+    expect(subject).to be_frozen
+  end
+
+  it "converts to a frozen hash" do
+    expect(subject.to_hash).to be_frozen
   end
 end
 

data/spec/finer_struct/shared_examples.rb

@@ -3,10 +3,27 @@ shared_examples "a struct" do
     expect(subject.a).to eq(1)
     expect(subject.b).to eq(2)
   end
+
+  it "responds to attribute names" do
+    expect(subject).to respond_to :a
+    expect(subject).to respond_to :b
+  end
+
+  it "responds to :class" do
+    expect(subject).to respond_to :class
+  end
+
+  it "doesn't respond to attribute names that the struct doesn't have" do
+    expect(subject).not_to respond_to :c
+  end
+
+  it "converts to a hash" do
+    expect(subject.to_hash).to eq(a: 1 ,b: 2)
+  end
 end
 
 shared_examples "a named struct" do
-  it "complains if you set an attribute that the struct doesn't have" do
-    expect { klass.new(c: 3) }.to raise_error(ArgumentError, "no such attribute: c")
+  it "complains if you set attributes that the struct doesn't have" do
+    expect { klass.new(c: 3, d: 4) }.to raise_error(ArgumentError, "unknown attributes: c, d")
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: finer_struct
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Pete Yandell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2016-03-17 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
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.0.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
 description: A nicer replacement for Ruby's Struct and OpenStruct
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,17 +83,17 @@ 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.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A nicer replacement for Ruby's Struct and OpenStruct