flex_struct 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caf46503e9a8152fa8f0e263643c8be5900ac8db
-  data.tar.gz: 1a5aefee1703e619e88c2fb4f0e618fcb832b98d
+  metadata.gz: be5088836ee8daf48c1348b406db1f7f57e20f2e
+  data.tar.gz: ff5c0e89a2ae853d337d4b2ba5fc945c65413f22
 SHA512:
-  metadata.gz: 8b0662189bbffdf683097d768121da164e5cbea58ad73f6866e7678a17d4dc0897fa94ee5df8039d645e1f2d59bea633ee7b0c366b95251bd2b34a8e6302e494
-  data.tar.gz: 1414dbe98a5a8e7fd03851ae85dbbc683e264bb0bf1757be5e3731877198f657850dcc5bf71ed04a3ab6e9a09dc94a0dc1327c7ed7f4b73ca15d886345af863d
+  metadata.gz: 95b8a633396b72cd8da9825b008e66e06f1c528ba873255b8f9927b138d760452cd02a24d7af8bb0735a036a0976979fd52f06a1590e31c778f9d8f22985b9fe
+  data.tar.gz: 7f4bd82e56b4a7fda380634a9302517b4d83bc7bd14aedf537cfb4ba1f3ffa246249190e98e2da17b7da871a98f6e72f28b22caf69a3a8fcd7191f38004f799a

data/.reek

@@ -0,0 +1,6 @@
+ModuleInitialize:
+  exclude:
+    - FlexStruct::Frozen
+    - FlexStruct::Initializer
+
+# vim: set ft=yaml:

data/Gemfile

@@ -5,3 +5,5 @@ gemspec
 # Gems which aren't development dependencies, but are useful for development
 gem "guard-bundler"
 gem "guard-rspec"
+
+gem "pry-byebug"

data/Guardfile

@@ -24,3 +24,5 @@ guard :rspec, cmd: "bundle exec rspec" do
   ruby = dsl.ruby
   dsl.watch_spec_files_for(ruby.lib_files)
 end
+
+# vim: set ft=ruby:

data/README.md

@@ -4,6 +4,8 @@ A drop-in replacement for Struct which adds a more flexible initialize method
 
 ## Usage
 
+### Basic
+
 Create a `FlexStruct` very similarly to how you'd use any other `Struct`:
 
     Pet = FlexStruct.new(:species, :name, :colour)
@@ -25,6 +27,35 @@ default `Struct`s:
       pet.colour = :tortoiseshell
     end
 
+### Customisation
+
+`FlexStruct` acts just like a `Struct` in other ways, you can customize its
+behaviour and add functionality to the generated class by passing a block to the
+`FlexStruct` constructor:
+
+    Person = FlexStruct.new(:forename, :surname) do
+      def fullname
+        [forename, surname].compact.join(" ")
+      end
+    end
+
+    Person.new(forename: "Finn", surname: "Mertens").fullname
+    # => "Finn Mertens"
+
+It's possible to overwrite the `initialize` method this way - so be sure to use
+`super` if you do this. Or better, don't do this, you probably don't need to.
+
+### Immutability
+
+`FlexStruct` comes with a convenience method for making immutable `Struct`s. This
+will amend the generated struct to make it frozen after initialization:
+
+    Position = FlexStruct.new(:lat, :lng) { prepend FlexStruct::Frozen }
+
+    location = Position.new(lat: 44.681, lng: 169.101)
+    location.lat = -70.850
+    # => RuntimeError: can't modify frozen Position
+
 ## Why?
 
 `Hash`es are great. You can use them to store arbitrary key/value pairs using

data/lib/flex_struct/frozen.rb

@@ -0,0 +1,9 @@
+class FlexStruct
+  # Wraps a FlexStruct initializer to freeze the struct instance after creation.
+  module Frozen
+    def initialize(*)
+      super
+      freeze
+    end
+  end
+end

data/lib/flex_struct/initializer.rb

@@ -0,0 +1,10 @@
+class FlexStruct
+  # FlexStruct's initializer adds two alternate ways to initialize a Struct
+  module Initializer
+    def initialize(*args, **kwargs)
+      super(*args)
+      kwargs.each { |key, val| self[key] = val }
+      yield self if block_given?
+    end
+  end
+end

data/lib/flex_struct/version.rb

@@ -1,3 +1,3 @@
 class FlexStruct
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/lib/flex_struct.rb

@@ -1,14 +1,16 @@
 # A drop-in replacement for Struct which adds a more flexible initialize method
 class FlexStruct
   autoload :VERSION, "flex_struct/version"
+  autoload :Frozen, "flex_struct/frozen"
+  autoload :Initializer, "flex_struct/initializer"
 
-  def self.new(*args)
+  def self.new(*args, &block)
     Struct.new(*args) do
-      def initialize(*args, **kwargs)
-        super(*args)
-        kwargs.each { |key, val| self[key] = val }
-        yield self if block_given?
-      end
+      module_eval(&block) if block
+
+      # Insert our `initialize` method into the ancestors chain so it can be
+      # overridden by `block` if necessary
+      include Initializer
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flex_struct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gareth Adams
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -87,6 +88,8 @@ files:
 - bin/setup
 - flex_struct.gemspec
 - lib/flex_struct.rb
+- lib/flex_struct/frozen.rb
+- lib/flex_struct/initializer.rb
 - lib/flex_struct/version.rb
 homepage: https://github.com/bridgeu/flex_struct
 licenses: