omnistruct 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2bca86c8dfacd6cc38fa06c599593f19ab4ad67
+  data.tar.gz: 203817b49cdaf1f902cc88d98f451c0a545b856c
+SHA512:
+  metadata.gz: d91807ccee8ac5a7e9abf1b30c042795cfc75a9bce15fe8fbfebce09588984267723ea539795a16b956de9f2522148c936903b677fd5f83439a7a53dd818e7bb
+  data.tar.gz: b8b4ff5b8c5c2086986451948d72bf6f3f18ddb79683d3b55b1fca4650dfcf894a2628d0627022a13e041e832e0ce9279626c52274f997bc6af7e2b96e5570e5

data/README.md

@@ -0,0 +1,70 @@
+OmniStruct - [![Build Status](https://travis-ci.org/jmervine/omnistruct.svg?branch=master)](https://travis-ci.org/jmervine/omnistruct)
+==========
+
+Helpers for using OpenStruct and/or Struct over Hash
+
+### Usage
+
+Require after or in place of `classy_struct`, `ostruct` and/or `struct`.
+
+```ruby
+# good
+require 'omnistruct`
+
+# also good
+require 'ostruct`
+require 'omnistruct`
+
+# bad
+require 'omnistruct`
+require 'ostruct`
+```
+
+> TODO: document the following better
+
+Add's the following methods to `Hash`;
+
+```ruby
+# Hash
+##
+
+# class methods
+Hash.struct_type
+Hash.struct_type=
+
+# instance methods
+Hash.new.to_struct(type=Hash.struct_type)
+```
+
+Add's the following common `Hash` methods to struct types;
+
+```ruby
+# All: ClassyStruct / OpenStruct / Struct
+##
+
+struct = <struct type>.to_struct( [type] )
+merged = <struct type>.merge( Hash.new | <struct type> )
+json   = <struct type>.to_json
+
+# ClassyStruct
+locked = <classy struct>.lock
+locked.class
+# => "Struct"
+
+# OpenStruct
+OpenStruct.new.merge!( Hash.new | <struct type> )
+
+locked = OpenStruct.new.lock
+locked.class
+# => "Struct"
+
+# Struct
+unlocked = <Struct>.unlock( [type] )
+```
+
+### Development
+
+```
+bundle install --path .bundle
+bundle exec ruby ./test.rb
+```

data/ext/classystruct.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), 'hash')
+require 'classy_struct'
+require 'json'
+
+# ClassyStruct patches
+####
+class ClassyStruct
+  class ClassyStructClass
+    alias :to_h :to_hash
+
+    # Convert ClassyStruct to Struct or OpenStruct
+    #
+    # Example:
+    #
+    #   struct = { :foo => :bar }.to_struct(:classy_struct)
+    #
+    #   # noop
+    #   s = struct.to_struct
+    #   s.class
+    #   #=> ClassyHashStruct
+    #
+    #   s = struct.to_struct(:struct)
+    #   s.class
+    #   #=> Struct
+    #
+    #   s = struct.to_struct(:open_struct)
+    #   s.class
+    #   #=> OpenStruct
+    def to_struct(type=:classy_struct)
+      return self if type.to_sym == :classy_struct
+      return self.to_h.to_struct(type)
+    end
+
+    def merge other
+      self.to_h.merge!(other.to_h).to_struct(:classy_struct)
+    end
+
+    # Convert ClassyStruct to Struct, thus locking it.
+    def lock
+      self.to_h.to_struct(:struct)
+    end
+
+    def to_json
+      self.to_h.to_json
+    end
+  end
+end

data/ext/hash.rb

@@ -0,0 +1,105 @@
+require 'json'
+
+# Supports converting Hashes in to different kinds of structs via a 'to_struct'
+# method.
+#
+# Note: ClassyStruct perferred over OpenStruct, it's faster.
+class Hash
+  CLASSY_STRUCT_NAME = "ClassyHashStruct"
+
+  attr_accessor :struct_type
+  @@struct_type = :classy_struct
+
+  # Convert Hash to Struct, OpenStruct or ClassyStruct
+  #
+  # Example:
+  #
+  #   hash = { :foo => :bar }
+  #
+  #   # default
+  #   s = hash.to_struct(:classy_struct)
+  #   s.class
+  #   #=> ClassyHashStruct
+  #   hash.foo
+  #   #=> :bar
+  #
+  #   s = hash.to_struct(:struct)
+  #   s.class
+  #   #=> Struct
+  #
+  #   s = hash.to_struct(:open_struct)
+  #   s.class
+  #   #=> OpenStruct
+  def to_struct(type=nil)
+    self.struct_type = type.nil? ? struct_type : type.to_sym
+
+    if struct_type == :classy_struct
+      begin
+        Object.send(:remove_const, CLASSY_STRUCT_NAME.to_sym)
+      rescue; end
+
+      return Object.const_set(CLASSY_STRUCT_NAME, ClassyStruct.new).new(self)
+    end
+
+    self.each do |k,v|
+      self[k] = v.to_struct(struct_type) if v.is_a? Hash
+    end
+
+    if struct_type == :open_struct
+      # openstruct is said to be slower, so giving the option to disable
+      return OpenStruct.new(self)
+    end
+
+    # otherwise use standard struct
+    return nil if self.empty?
+
+    klass = Struct.new(*keys.map{|key| key.to_sym})
+    klass.new(*values)
+  end
+
+  # Return struct type for instance.
+  #
+  # Example:
+  #
+  #   hash = { :foo => :bar }
+  #
+  #   # default
+  #   hash.struct_type
+  #   #=> :classy_struct
+  def struct_type
+    @struct_type || @@struct_type
+  end
+
+  # Return struct type for class.
+  #
+  # Example:
+  #
+  #   Hash.struct_type
+  #   #=> :classy_struct
+  #
+  def self.struct_type
+    @@struct_type
+  end
+
+  # Set struct type for class.
+  #
+  # Example:
+  #
+  #   Hash.struct_type = :struct
+  #   Hash.struct_type
+  #   #=> :struct
+  #   hash = { :foo => :bar }
+  #   hash.struct_type
+  #   #=> :struct
+  def self.struct_type= type
+    type = type.to_sym
+    raise "Invalid struct type: #{type}." unless struct_types.include?(type)
+
+    @@struct_type = type.to_sym
+  end
+
+  protected
+  def self.struct_types
+    [ :classy_struct, :open_struct, :struct ]
+  end
+end

data/ext/openstruct.rb

@@ -0,0 +1,51 @@
+require File.join(File.dirname(__FILE__), 'hash')
+require 'ostruct'
+require 'json'
+
+class OpenStruct
+  # replaces object
+  def merge! other
+    self.marshal_load(merge(other).to_h)
+  end
+
+  # returns new object
+  def merge other
+    OpenStruct.new(self.marshal_dump.merge(other.to_h))
+  end
+
+  def to_json
+    self.marshal_dump.to_json
+  end
+
+  # Convert OpenStruct to Struct, thus locking it.
+  def lock
+    self.marshal_dump.to_struct(:struct)
+  end
+
+  def unlock
+    self # noop
+  end
+
+  # Convert OpenStruct to Struct or ClassyStruct
+  #
+  # Example:
+  #
+  #   struct = { :foo => :bar }.to_struct(:classy_struct)
+  #
+  #   # noop
+  #   s = struct.to_struct
+  #   s.class
+  #   #=> OpenStruct
+  #
+  #   s = struct.to_struct(:struct)
+  #   s.class
+  #   #=> Struct
+  #
+  #   s = struct.to_struct(:classy_struct)
+  #   s.class
+  #   #=> ClassyHashStruct
+  def to_struct(type=:open_struct)
+    return self if type.to_sym == :open_struct
+    return self.marshal_dump.to_struct(type)
+  end
+end

data/ext/struct.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), 'hash')
+require 'json'
+
+class Struct
+  # returns new object
+  def merge other
+    selfHash = self.to_h
+    otherHash = other.is_a?(Hash) ? other : other.to_h
+
+    selfHash.merge!(otherHash)
+    selfHash.to_struct(:struct)
+  end
+
+  def lock
+    self #noop
+  end
+
+  # Convert Struct to OpenStruct or ClassyStruct (default), thus unlocking it.
+  def unlock(type=:classy_struct)
+    return nil if type.to_sym == :struct
+    return self.to_h.to_struct(type)
+  end
+
+  def to_json
+    self.to_h.to_json
+  end
+
+  # Convert Struct # to OpenStruct or ClassyStruct
+  #
+  # Example:
+  #
+  #   struct = { :foo => :bar }.to_struct(:struct)
+  #
+  #   # noop
+  #   s = struct.to_struct
+  #   s.class
+  #   #=> Struct
+  #
+  #   s = struct.to_struct(:open_struct)
+  #   s.class
+  #   #=> OpenStruct
+  #
+  #   s = struct.to_struct(:classy_struct)
+  #   s.class
+  #   #=> ClassyHashStruct
+  def to_struct(type=:classy_struct)
+    return self if type.to_sym == :struct
+    return self.to_h.to_struct(type)
+  end
+end
+
+

data/omnistruct.rb

@@ -0,0 +1,43 @@
+Dir.glob(File.join(File.dirname(__FILE__), 'ext', '*.rb')).each do |lib|
+  require lib
+end
+require 'json'
+
+# Top level class, mainly for correct requiring, but wraps Hash extensions as
+# well.
+module OmniStruct
+  # Wraps Hash.to_struct
+  #
+  # Examples:
+  #
+  #   s = OmniStruct.new({:foo => :bar})
+  #   s.class
+  #   #=> ClassyHashStruct
+  #   s.foo
+  #   #=> :bar
+  #
+  #   s = OmniStruct.new({:foo => :bar})
+  #   s.class
+  #   #=> ClassyHashStruct
+  #   s.foo
+  #   #=> :bar
+  def self.new hash=Hash.new, type=Hash.struct_type
+    return hash.to_struct(type)
+  end
+
+  # Wraps Hash.struct_type
+  def self.struct_type
+    Hash.struct_type
+  end
+
+  # Wraps Hash.struct_type=
+  def self.struct_type= type
+    Hash.struct_type = type
+  end
+
+  protected
+  # Wraps Hash.struct_types
+  def self.struct_types
+    Hash.send(:struct_types)
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: omnistruct
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Joshua Mervine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: classy_struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+description: 'OmniStruct: Struct Utilities -- Helpers for ClassyStruct, OpenStruct
+  and Struct'
+email:
+- joshua@mervine.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- ext/classystruct.rb
+- ext/hash.rb
+- ext/openstruct.rb
+- ext/struct.rb
+- omnistruct.rb
+homepage: https://github.com/jmervine/omnistruct
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- "."
+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.2.2
+signing_key: 
+specification_version: 4
+summary: 'OmniStruct: Struct Utilities'
+test_files: []