rschema_hamster 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d51cbfa9644a3a7c41cddbda5e9487687cb7e550
+  data.tar.gz: 9447762eb704849daa902bd3fd7dabad102bc04f
+SHA512:
+  metadata.gz: 2622279af6818f76227d8654414bef9a1dd69dfd9081525617398792a6a14b3ead95330c8af3d66db17fa8b852dc575b70c8a4d01a286e30c115a1f7ad0706b6
+  data.tar.gz: c21f7acd1cfb2c2583efebd81fa11ccef567da0fa92146a754a851c72a0d95eb9c9d114efc908550c7fb4b30d0550fc08bbca899123836206f68f31db3dc0c6f

data/LICENSE.txt

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/Readme.md

@@ -0,0 +1,51 @@
+# RSchema-Hamster
+
+Extends [RSchema][RSCHEMA-DOC] to support [Hamster's][HAMSTER-DOC] immutable Hash, Vector, List and Set structures.
+
+```ruby
+Email = String
+PostalCode = String
+
+Person = Hamster.hash(
+  name: String,
+  email: Email
+)
+
+Address = Hamster.hash(
+  street: String,
+  postal_code: PostalCode
+)
+
+Contact = Hamster.hash(
+  person: Person,
+  addresses: Hamster.vector(Address)
+)
+
+ContactList = Hamster.vector(Contact)
+```
+
+DONE:
+
+* Hamster::Vector
+* Hamster::Hash - known keys
+* Hamster::List 
+* Test DSL:
+** _?
+** maybe
+** hamster_hash_of
+** hamster_set_of - Hasmter::Set -(GenericHamsterSetSchema)
+** enum
+
+TODO:
+
+Project:
+* Proper readme
+* .gem
+
+Implement someday:
+
+* Structs
+* Hamsterdam::Struct
+
+[HAMSTER-DOC]: https://github.com/hamstergem/hamster 
+[RSCHEMA-DOC]: https://github.com/tomdalling/rschema

data/lib/rschema_hamster/dsl.rb

@@ -0,0 +1,48 @@
+module RSchemaHamster
+  module DSL
+    def hamster_hash_of(subschemas_hash)
+      raise InvalidSchemaError unless subschemas_hash.size == 1
+      GenericHamsterHashSchema.new(
+        subschemas_hash.keys.first, 
+        subschemas_hash.values.first)
+    end
+
+    def hamster_set_of(subschema)
+      GenericHamsterSetSchema.new(subschema)
+    end
+  end
+  
+  GenericHamsterHashSchema = Struct.new(:key_subschema, :value_subschema) do
+    def schema_walk(value, mapper)
+      if not value.is_a?(Hamster::Hash)
+        return RSchema::ErrorDetails.new(value, 'is not a Hamster::Hash')
+      end
+
+      value.reduce(Hamster.hash) do |accum, (k, v)|
+        # walk key
+        k_walked, error = RSchema.walk(key_subschema, k, mapper)
+        break error.extend_key_path('.keys') if error
+
+        # walk value
+        v_walked, error = RSchema.walk(value_subschema, v, mapper)
+        break error.extend_key_path(k) if error
+
+        accum.put(k_walked, v_walked)
+      end
+    end
+  end
+
+  GenericHamsterSetSchema = Struct.new(:subschema) do
+    def schema_walk(value, mapper)
+      return RSchema::ErrorDetails.new(value, 'is not a Hamster::Set') if not value.is_a?(Hamster::Set)
+
+      value.reduce(Hamster.set) do |accum, subvalue|
+        subvalue_walked, error = RSchema.walk(subschema, subvalue, mapper)
+        break error.extend_key_path('.values') if error
+
+        accum.add subvalue_walked
+      end
+    end
+  end
+end
+

data/lib/rschema_hamster/version.rb

@@ -0,0 +1,3 @@
+module RSchemaHamster
+  VERSION = '0.0.2'
+end

data/lib/rschema_hamster.rb

@@ -0,0 +1,99 @@
+require 'rschema'
+require 'hamster'
+require 'rschema_hamster/dsl'
+
+class Hamster::Vector
+  def schema_walk(value, mapper)
+    fixed_size = (self.size != 1)
+
+    if not value.is_a?(Hamster::Vector)
+      RSchema::ErrorDetails.new(value, 'is not a Hamster::Vector')
+    elsif fixed_size && value.size != self.size
+      RSchema::ErrorDetails.new(value, "does not have #{self.size} elements")
+    else
+      value.map.with_index do |subvalue, idx|
+        subschema = (fixed_size ? self[idx] : first)
+        subvalue_walked, error = RSchema.walk(subschema, subvalue, mapper)
+        break error.extend_key_path(idx) if error
+        subvalue_walked
+      end
+    end
+  end
+end
+
+class Hamster::Cons
+  def schema_walk(value, mapper)
+    fixed_size = (self.size != 1)
+
+    if value == Hamster::EmptyList and !fixed_size
+      value
+    elsif not value.is_a?(Hamster::Cons)
+      RSchema::ErrorDetails.new(value, 'is not a Hamster List')
+    elsif fixed_size && value.size != self.size
+      RSchema::ErrorDetails.new(value, "does not have #{self.size} elements")
+    else
+      result = Hamster.list
+      failure = nil
+      value.each.with_index do |subvalue, idx|
+        subschema = (fixed_size ? self[idx] : first)
+        subvalue_walked, error = RSchema.walk(subschema, subvalue, mapper)
+        if error 
+          error.extend_key_path(idx)
+          failure = error
+          break
+        else
+          result = result.cons(subvalue_walked)
+        end
+      end
+      return (failure or result.reverse)
+
+    end
+  end
+end
+
+class Hamster::Hash
+  def schema_walk(value, mapper)
+    return RSchema::ErrorDetails.new(value, 'is not a Hash') if not value.is_a?(Hamster::Hash)
+
+    # extract details from the schema
+    required_keys = Set.new
+    all_subschemas = {}
+    each do |(k, subschema)|
+      if k.is_a?(RSchema::OptionalHashKey)
+        all_subschemas[k.key] = subschema
+      else
+        required_keys << k
+        all_subschemas[k] = subschema
+      end
+    end
+
+    # check for extra keys that shouldn't be there
+    extraneous = value.keys.reject{ |k| all_subschemas.has_key?(k) }
+    if extraneous.size > 0
+      return RSchema::ErrorDetails.new(value, "has extraneous keys: #{extraneous.to_a.inspect}")
+    end
+
+    # check for required keys that are missing
+    missing_requireds = required_keys.reject{ |k| value.has_key?(k) }
+    if missing_requireds.size > 0
+      return RSchema::ErrorDetails.new(value, "is missing required keys: #{missing_requireds.to_a.inspect}")
+    end
+
+    # walk the subvalues
+    value.reduce(Hamster.hash) do |accum, (k, subvalue)|
+      # puts "RSchema.walk(all_subschemas[k], subvalue, mapper) all_subschemas[#{k.inspect}]: #{all_subschemas[k].inspect}, subvalue: (#{subvalue.class}) #{subvalue.inspect}"
+      subvalue_walked, error = RSchema.walk(all_subschemas[k], subvalue, mapper)
+      # puts "  => subvalue_walked: (#{subvalue_walked.class}) #{subvalue_walked.inspect}, error: #{error.inspect}"
+      break error.extend_key_path(k) if error
+      a = accum.put(k, subvalue_walked)
+      # puts "  (accum: #{accum.inspect})"
+      a
+    end
+  end
+end
+
+module RSchema
+  module DSL
+    extend RSchemaHamster::DSL
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rschema_hamster
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- David Crosby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hamster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rschema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: awesom_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |2
+      RSchema extension to support Hamster's immutable Hash, Vector, List, Set.
+      Immutable values, well-defined structures.
+      Depends on tomdalling/rschema and hamstergem/hamster.
+email:
+- crosby@atomicobject.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- Readme.md
+- lib/rschema_hamster.rb
+- lib/rschema_hamster/dsl.rb
+- lib/rschema_hamster/version.rb
+homepage: https://github.com/dcrosby42
+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.2.2
+signing_key: 
+specification_version: 4
+summary: RSchema extension to support Hamster's immutable Hash, Vector, List, Set
+test_files: []