blumquist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb3fa8a72a576d8cc9343cf7fa6ad38125a763d1
+  data.tar.gz: dadff91b9e4aa6909d97e8e46b254b033333c141
+SHA512:
+  metadata.gz: 358263522e0cd18da0b2690cfe8832121eb5234cf33a033cda0007cfaf0e0841454a366ecf15ecaef46895e9e535084966c79c65480f74dfdd18bbd4190d2033
+  data.tar.gz: 2c3f956c6b52928ddc45579802a8ac291df640c1da8d0c9a02b28e458d265e93462c912a7880f6d4e748b825d6a78ad59c2b38802a8671e3e21372992b9f530f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+gems.tags
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blumquist.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,41 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :bundler do
+  watch('Gemfile')
+  # Uncomment next line if your Gemfile contains the `gemspec' command.
+  watch(/^.+\.gemspec/)
+end
+
+guard 'ctags-bundler', :src_path => ["lib"] do
+  watch(/^(app|lib|spec\/support)\/.*\.rb$/)
+  watch('Gemfile.lock')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'IGNORE_LOW_COVERAGE=1 rspec', all_on_start: true  do
+  watch(%r{^spec/support/.*\.mson$}) { "spec" }
+  watch(%r{^spec/support/.*\.rb$}) { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # We could run individual specs, sure, but for now I dictate the tests
+  # are only green when we have 100% coverage, so partial runs will never
+  # succeed. Therefore, always run all the things.
+  watch(%r{^(spec/.+_spec\.rb)$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jannis Hermanns
+
+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,108 @@
+# Blumquist [![Circle CI](https://circleci.com/gh/moviepilot/blumquist/tree/master.svg?style=svg)](https://circleci.com/gh/moviepilot/blumquist/tree/master) [![Coverage Status](https://coveralls.io/repos/moviepilot/blumquist/badge.svg?branch=master&service=github)](https://coveralls.io/github/moviepilot/blumquist?branch=master)
+
+![](https://dl.dropboxusercontent.com/u/1953503/blumquist.jpg)
+
+Given a JSON schema and some data, Blumquist will give you an immutable object that has getters defined for all properties from the JSON schema. Works well with schemas using JSON pointers as well as for properties that are themselves objects or arrays.
+
+## Usage
+
+1. Give it a schema
+2. Give it some data
+3. Get an object with getters
+
+(Sorry, no profit step.)
+
+### 1. Give it a schema
+
+```json
+schema = {
+  "$schema": "http://json-schema.org/draft-04/schema#",
+
+  "definitions": {
+    "address": {
+      "type": "object",
+      "properties": {
+        "street": { "type": "string" },
+        "city":   { "type": "string" },
+        "state":  { "type": "string" }
+      },
+      "required": ["street", "city", "state"]
+    }
+  },
+
+  "type": "object",
+
+  "properties": {
+    "name": { "type": "string" },
+    "current_address": { "$ref": "#/definitions/address" },
+    "old_addresses": { "type": "array", "items": { "$ref": "#/definitions/address"   } }
+  }
+}
+```
+
+### 2. Give it some data
+```ruby
+data = {
+  "name": "Moviepilot, Inc.",
+  "current_address": {
+    "street_address": "Friedrichstr. 58",
+    "city": "Berlin",
+    "state": "Berlin"
+  },
+  "old_addresses": [
+    {
+      "street_address": "Blücherstr. 22",
+      "city": "Berlin",
+      "state": "Berlin"
+    },
+    {
+      "street_address": "Mehringdamm 33",
+      "city": "Berlin",
+      "state": "Berlin"
+    }
+  ]
+}
+
+```
+### 3. And you get...
+... an object with getters for all properties defined in the schema
+
+```ruby
+> b = Blumquist.new(schema, data)
+=> #<Blumquist:0x....>
+> b.name
+=> "Moviepilot, Inc."
+> b.old_addresses.first.street
+=> "Blücherstr. 22"
+```
+
+## TODO
+
+- Put it to use, fix bugs
+- Validate data against schema and reject invalid data
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blumquist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blumquist
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub in the [issues section](https://github.com/moviepilot/blumquist/issues). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/blumquist.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blumquist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blumquist"
+  spec.version       = Blumquist::VERSION
+  spec.authors       = ["Jannis Hermanns"]
+  spec.email         = ["jannis@moviepilot.com"]
+
+  spec.summary       = "Turn some data and a json schema into an immutable object with getters from the schema"
+  spec.description   = "What the summary said."
+  spec.homepage      = "https://github.com/moviepilot/blumquist"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-ctags-bundler"
+end

data/lib/blumquist.rb

@@ -0,0 +1,101 @@
+require 'pry'
+require "blumquist/version"
+require 'active_support/core_ext/hash/indifferent_access'
+require 'json'
+
+class Blumquist
+  def initialize(schema, data)
+    # Poor man's deep clone: json 🆗 🆒
+    @data = JSON.parse(data.to_json)
+    @schema = schema.with_indifferent_access
+
+    validate_schema
+    resolve_json_pointers
+    define_getters
+  rescue
+    binding.pry
+  end
+
+  private 
+
+  def validate_schema
+    if @schema[:type] != 'object'
+      raise "Can only deal with 'object' types, not '#{@schema[:type]}'"
+    end
+    unless @schema[:properties].is_a?(Hash)
+      raise "Properties are a #{@schema[:properties].class.name}, not a Hash"
+    end
+  end
+
+  def resolve_json_pointers
+    @schema[:properties].each do |property, type_def|
+      next unless type_def[:$ref]
+      resolve_json_pointer!(type_def) 
+    end
+  end
+
+  def resolve_json_pointer!(type_def)
+    # Should read up on how json pointers are really resolved
+    pointer = type_def.delete(:$ref)
+    key = pointer.split('/').last
+    definition = @schema[:definitions][key]
+
+    raise "Can't resolve pointer #{pointer}" unless definition
+
+    type_def.merge! definition
+  end
+
+  def primitive_type?(type)
+    %w{null boolean number string}.include? type.to_s
+  end
+
+  def define_getters
+    @schema[:properties].each do |property, type_def|
+
+      # Wrap objects recursively
+      if type_def[:type] == 'object'
+        blumquistify_object(property)
+
+      # Turn array elements into Blumquists
+      elsif type_def[:type] == 'array'
+        blumquistify_array(property)
+
+      # Nothing to do for primitive values
+      elsif primitive_type?(type_def[:type])
+
+      # We don't know what to do, so let's panic
+      else
+        raise "Can't handle type '#{type_def}' yet, I'm sorry"
+      end
+
+      # And define the getter
+      define_getter(property)
+    end
+  end
+
+  def define_getter(property)
+    self.class.class_eval do 
+      define_method(property) do
+        @data[property]
+      end
+    end
+  end
+
+  def blumquistify_object(property)
+    sub_schema = @schema[:properties][property].merge(
+      definitions: @schema[:definitions]
+    )
+    @data[property] = Blumquist.new(sub_schema, @data[property])
+  end
+
+  def blumquistify_array(property)
+    item_schema = resolve_json_pointer!(@schema[:properties][property][:items])
+    sub_schema = item_schema.merge(
+      definitions: @schema[:definitions]
+    )
+    @data[property] ||= []
+    @data[property] = @data[property].map do |item|
+      Blumquist.new(sub_schema, item)
+    end
+  end
+end

data/lib/blumquist/version.rb

@@ -0,0 +1,3 @@
+class Blumquist
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: blumquist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jannis Hermanns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: simplecov
+  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: guard-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'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  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: guard-ctags-bundler
+  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: What the summary said.
+email:
+- jannis@moviepilot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blumquist.gemspec
+- lib/blumquist.rb
+- lib/blumquist/version.rb
+homepage: https://github.com/moviepilot/blumquist
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Turn some data and a json schema into an immutable object with getters from
+  the schema
+test_files: []