finer_struct 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ff4c771933bc1229752c3dd6fbfb219d5b55604
+  data.tar.gz: 0b77229e6afe0798f66c7dd0c59c6c2988f01d6a
+SHA512:
+  metadata.gz: 17822ca2377411bbf76ff5f81815b75a3639f5b09d4fc2e23488efc6ddd1ed53d94c2871ca541f02261dc3aec9bb8ad9e7d317277ecd448bc1b6c0d74e73d730
+  data.tar.gz: ed4d9c72e5898f3a2c8c5e398498ba717b61703c0d17e336991be1455f301781ab17e514d4621ff5d08e360e8b16e069ffdf12aa06db4aacb535e6955985fdee

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pete Yandell
+
+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,72 @@
+# FinerStruct
+
+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?
+
+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?
+
+Did you know that creating an `OpenStruct` blows away Ruby's method cache?
+
+Isn't it irritating how you have to remember that, to use `OpenStruct`, you need to `require 'ostruct'`?
+
+Have you ever wished you could create a `Struct` or `OpenStruct`, but make it immutable?
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'finer_struct'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install finer_struct
+
+## Usage
+
+### Immutable Structs
+
+Immutable structs can't have their attributes changed after creation.
+
+#### Anonymous immutable structs
+
+    struct = FinerStruct::Immutable.new(a: 1, b: 2)
+
+    struct.a # => 1
+    struct.b # => 2
+    struct.a = 3 # Exception!
+
+#### Named immutable structs
+
+    class MyStruct < FinerStruct::Immutable(:a, :b)
+    struct = MyStruct.new(a: 1, b: 2)
+
+    MyStruct.new(a: 1, b: 2, c: 3) # Exception!
+
+### Mutable Structs
+
+Mutable structs let you assign attributes at any time.
+
+#### Anonymous mutable structs
+
+    struct = FinerStruct::Mutable.new(a: 1, b: 2)
+
+    struct.a = 3
+    struct.a # => 3
+
+#### Named mutable structs
+
+    class MyStruct < FinerStruct::Mutable(:a, :b)
+    struct = MyStruct.new(a: 1, b: 2)
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/finer_struct.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'finer_struct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "finer_struct"
+  spec.version       = FinerStruct::VERSION
+  spec.authors       = ["Pete Yandell"]
+  spec.email         = ["pete@notahat.com"]
+  spec.description   = %q{Nicer replacement for Ruby's Struct and OpenStruct}
+  spec.summary       = %q{Nicer replacement for Ruby's Struct and OpenStruct}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/finer_struct/immutable.rb

@@ -0,0 +1,38 @@
+module FinerStruct
+
+  class Immutable
+    def initialize(attributes = {})
+      @attributes = attributes.dup
+    end
+
+    def method_missing(method, *arguments)
+      if @attributes.has_key?(method)
+        @attributes[method]
+      else
+        super
+      end
+    end
+  end
+
+  def self.Immutable(*attribute_names)
+    Class.new do
+      @attribute_names = attribute_names
+
+      class << self
+        attr_reader :attribute_names
+      end
+
+      attr_reader(*attribute_names)
+
+      def initialize(attributes = {})
+        attributes.each_pair do |key, value|
+          unless self.class.attribute_names.include?(key)
+            raise(ArgumentError, "no such attribute: #{key}")
+          end
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+  end
+
+end

data/lib/finer_struct/mutable.rb

@@ -0,0 +1,47 @@
+require 'finer_struct/immutable'
+
+module FinerStruct
+
+  class Mutable < Immutable
+    def method_missing(method, *arguments)
+      if is_assigment?(method) && @attributes.has_key?(key_for_assignment(method))
+        @attributes[key_for_assignment(method)] = arguments[0]
+      else
+        super
+      end
+    end
+
+  private
+
+    def is_assigment?(method)
+      method.to_s.end_with?("=")
+    end
+
+    def key_for_assignment(method)
+      method.to_s[0..-2].to_sym
+    end
+  end
+
+  def self.Mutable(*attribute_names)
+    Class.new do
+      @attribute_names = attribute_names
+
+      class << self
+        attr_reader :attribute_names
+      end
+
+      attr_accessor(*attribute_names)
+
+      def initialize(attributes = {})
+        attributes.each_pair do |key, value|
+          unless self.class.attribute_names.include?(key)
+            raise(ArgumentError, "no such attribute: #{key}")
+          end
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+  end
+
+end
+

data/lib/finer_struct/version.rb

@@ -0,0 +1,3 @@
+module FinerStruct
+  VERSION = "0.0.1"
+end

data/lib/finer_struct.rb

@@ -0,0 +1,4 @@
+require "finer_struct/version"
+require "finer_struct/immutable"
+require "finer_struct/mutable"
+

data/spec/finer_struct/immutable_spec.rb

@@ -0,0 +1,28 @@
+require 'finer_struct/immutable'
+require 'finer_struct/shared_examples'
+
+shared_examples "an immutable struct" do
+  it_behaves_like "a struct"
+
+  it "complains if you try to write an attribute" do
+    expect { subject.a = 3 }.to raise_error(NoMethodError)
+  end
+end
+
+module FinerStruct
+
+  describe "an anonymous immutable struct" do
+    subject { FinerStruct::Immutable.new(a: 1, b: 2) }
+
+    it_behaves_like "an immutable struct"
+  end
+
+  describe "a named immutable struct" do
+    let(:klass)  { FinerStruct::Immutable(:a, :b) }
+    subject      { klass.new(a: 1, b: 2) }
+
+    it_behaves_like "an immutable struct"
+    it_behaves_like "a named struct"
+  end
+
+end

data/spec/finer_struct/mutable_spec.rb

@@ -0,0 +1,29 @@
+require 'finer_struct/mutable'
+require 'finer_struct/shared_examples'
+
+shared_examples "a mutable struct" do
+  it_behaves_like "a struct"
+
+  it "lets you write attributes" do
+    subject.a = 3
+    expect(subject.a).to eq(3)
+  end
+end
+
+module FinerStruct
+
+  describe "an anonymous mutable struct" do
+    subject { FinerStruct::Mutable.new(a: 1, b: 2) }
+
+    it_behaves_like "a mutable struct"
+  end
+
+  describe "a named mutable struct" do
+    let(:klass)  { FinerStruct::Mutable(:a, :b) }
+    subject      { klass.new(a: 1, b: 2) }
+
+    it_behaves_like "a mutable struct"
+    it_behaves_like "a named struct"
+  end
+
+end

data/spec/finer_struct/shared_examples.rb

@@ -0,0 +1,12 @@
+shared_examples "a struct" do
+  it "lets you read attributes" do
+    expect(subject.a).to eq(1)
+    expect(subject.b).to eq(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")
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: finer_struct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pete Yandell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-24 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: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Nicer replacement for Ruby's Struct and OpenStruct
+email:
+- pete@notahat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- finer_struct.gemspec
+- lib/finer_struct.rb
+- lib/finer_struct/immutable.rb
+- lib/finer_struct/mutable.rb
+- lib/finer_struct/version.rb
+- spec/finer_struct/immutable_spec.rb
+- spec/finer_struct/mutable_spec.rb
+- spec/finer_struct/shared_examples.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Nicer replacement for Ruby's Struct and OpenStruct
+test_files:
+- spec/finer_struct/immutable_spec.rb
+- spec/finer_struct/mutable_spec.rb
+- spec/finer_struct/shared_examples.rb