rom-json 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5355ab062f27eb38e6db6e53e4b613a37eb61712
+  data.tar.gz: 12ebdf3a86a4c07b09c0e09aa186b0c2bec862f5
+SHA512:
+  metadata.gz: 4c3e5c2ee1fe76b03f31132043bfd8bb26d84e6473d9e2b324a78354cbfe7ae8997f7f0f2dc5b856d8c44fe12ddacedf42b643ac14ff8e69afcf55f4d5cc66cf
+  data.tar.gz: 1c73405a116c7f68162f03260102903d2255d1b43d2b3a8933fcfa4a38125b0044fb89fe5dc106f3f23f8e4dd2283d8b1a28b91ea27e8e3278a536e8c2baa238

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,63 @@
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml
+
+# It’s quite readable when we know what we are doing
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# No need to handle LoadError in rake
+Lint/HandleExceptions:
+  Exclude:
+    - rakelib/*.rake
+
+# The enforced style doesn’t match Vim’s defaults
+Style/AlignParameters:
+  Enabled: false
+
+# UTF-8 is perfectly fine in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Allow using braces for value-returning blocks
+Style/Blocks:
+  Enabled: false
+
+# Documentation checked by Inch CI
+Style/Documentation:
+  Enabled: false
+
+# Early returns have their vices
+Style/GuardClause:
+  Enabled: false
+
+# Need to be skipped for >-> usage
+Style/Lambda:
+  Enabled: false
+
+# Multiline block chains are ok
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Even a single escaped slash can be confusing
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+# Don’t introduce semantic fail/raise distinction
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Need to be skipped for >-> usage
+Style/SpaceAroundOperators:
+  Enabled: false
+
+# Accept both single and double quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Allow def self.foo; @foo; end
+Style/TrivialAccessors:
+  Enabled: false
+
+# Allow rom-csv
+Style/FileName:
+    Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,6 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-02-09 17:10:04 +0100 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+bundler_args: --without tools
+env:
+  - CODECLIMATE_REPO_TOKEN=ef69eb6a9e19987527e5010a02bbf71cd4ddc8a5137ba308f299817f56d06e7f
+script: "bundle exec rake spec"
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/39e1225f489f38b0bd09
+    on_success: change
+    on_failure: always
+    on_start: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1 2015-08-07
+
+First public release

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'byebug', platform: :mri
+  gem 'inflecto'
+  gem 'rom', git: 'https://github.com/rom-rb/rom.git', branch: 'master'
+  gem 'rspec', '~> 3.1'
+  gem 'codeclimate-test-reporter', require: false
+  gem 'virtus'
+end
+
+group :tools do
+  gem 'rubocop'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotr Solnica
+
+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,40 @@
+[gem]: https://rubygems.org/gems/rom-json
+[travis]: https://travis-ci.org/rom-rb/rom-json
+[gemnasium]: https://gemnasium.com/rom-rb/rom-json
+[codeclimate]: https://codeclimate.com/github/rom-rb/rom-json
+[inchpages]: http://inch-ci.org/github/rom-rb/rom-json
+
+# ROM::JSON
+
+[![Gem Version](https://badge.fury.io/rb/rom-json.svg)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom-json.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-json.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/rom-rb/rom-json/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-json/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom-json.svg?branch=master)][inchpages]
+
+JSON support for [Ruby Object Mapper](https://github.com/rom-rb/rom)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rom-json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom-json
+
+## Usage
+
+See `spec/integration/adapter_spec.rb` for a sample usage.
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/rom-json.rb

@@ -0,0 +1 @@
+require 'rom/json'

data/lib/rom/json.rb

@@ -0,0 +1,7 @@
+require 'rom'
+
+require 'rom/json/version'
+require 'rom/json/gateway'
+require 'rom/json/relation'
+
+ROM.register_adapter(:json, ROM::JSON)

data/lib/rom/json/dataset.rb

@@ -0,0 +1,17 @@
+require 'rom/memory/dataset'
+
+module ROM
+  module JSON
+    # JSON in-memory dataset used by JSON gateways
+    #
+    # @api public
+    class Dataset < ROM::Memory::Dataset
+      # Data-row transformation proc
+      #
+      # @api private
+      def self.row_proc
+        Transproc[:hash_recursion, Transproc[:symbolize_keys]]
+      end
+    end
+  end
+end

data/lib/rom/json/gateway.rb

@@ -0,0 +1,114 @@
+require 'json'
+
+require 'rom/gateway'
+require 'rom/json/dataset'
+
+module ROM
+  module JSON
+    # JSON gateway
+    #
+    # Connects to a json file and uses it as a data-source
+    #
+    # @example
+    #   ROM.setup(:json, '/path/to/data.yml')
+    #
+    #   rom = ROM.finalize.env
+    #
+    #   gateway = rom.gateways[:default]
+    #
+    #   gateway.dataset?(:users) # => true
+    #   gateway[:users] # => data under 'users' key from the json file
+    #
+    # @api public
+    class Gateway < ROM::Gateway
+      # @attr_reader [Hash] sources Data loaded from files
+      #
+      # @api private
+      attr_reader :sources
+
+      # @attr_reader [Hash] datasets JSON datasets from sources
+      #
+      # @api private
+      attr_reader :datasets
+
+      # Create a new json gateway from a path to file(s)
+      #
+      # @example
+      #   gateway = ROM::JSON::Gateway.new('/path/to/files')
+      #
+      # @param [String, Pathname] path The path to your JSON file(s)
+      #
+      # @return [Gateway]
+      #
+      # @api public
+      def self.new(path)
+        super(load_from(path))
+      end
+
+      # Load data from json file(s)
+      #
+      # @api private
+      def self.load_from(path)
+        if File.directory?(path)
+          load_files(path)
+        else
+          load_file(path)
+        end
+      end
+
+      # Load json files from a given directory and return a name => data map
+      #
+      # @api private
+      def self.load_files(path)
+        Dir["#{path}/*.json"].each_with_object({}) do |file, h|
+          name = File.basename(file, '.*')
+          h[name] = load_file(file).fetch(name)
+        end
+      end
+
+      # Load json file
+      #
+      # @api private
+      def self.load_file(path)
+        ::JSON.parse(File.read(path))
+      end
+
+      # @param [String] path The absolute path to json file
+      #
+      # @api private
+      def initialize(sources)
+        @sources = sources
+        @datasets = {}
+      end
+
+      # Return dataset by its name
+      #
+      # @param [Symbol]
+      #
+      # @return [Array<Hash>]
+      #
+      # @api public
+      def [](name)
+        datasets.fetch(name)
+      end
+
+      # Register a new dataset
+      #
+      # @param [Symbol]
+      #
+      # @return [Dataset]
+      #
+      # @api public
+      def dataset(name)
+        datasets[name] = Dataset.new(sources.fetch(name.to_s))
+      end
+
+      # Return if a dataset with provided name exists
+      #
+      # @api public
+      def dataset?(name)
+        datasets.key?(name)
+      end
+    end
+  end
+end

data/lib/rom/json/relation.rb

@@ -0,0 +1,12 @@
+require 'rom/relation'
+
+module ROM
+  module JSON
+    # JSON-specific relation subclass
+    #
+    # @api private
+    class Relation < ROM::Relation
+      forward :join, :project, :restrict, :order
+    end
+  end
+end

data/lib/rom/json/version.rb

@@ -0,0 +1,5 @@
+module ROM
+  module JSON
+    VERSION = '0.0.1'.freeze
+  end
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+
+  namespace :rubocop do
+    desc 'Generate a configuration file acting as a TODO list.'
+    task :auto_gen_config do
+      exec "bundle exec rubocop --auto-gen-config"
+    end
+  end
+
+rescue LoadError
+end

data/rom-json.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rom/json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rom-json'
+  spec.version       = ROM::JSON::VERSION.dup
+  spec.authors       = ['Piotr Solnica', "Rolf Bjaanes"]
+  spec.email         = ['piotr.solnica@gmail.com']
+  spec.summary       = 'JSON support for Ruby Object Mapper'
+  spec.description   = spec.summary
+  spec.homepage      = 'http://rom-rb.org'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rom', '~> 0.8', '>= 0.8.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop', '~> 0.28.0'
+end

data/spec/fixtures/db/tasks.json

@@ -0,0 +1,13 @@
+{
+  "tasks": [
+    {
+      "title": "Task One"
+    },
+    {
+      "title": "Task Two"
+    },
+    {
+      "title": "Task Three"
+    }
+  ]
+}

data/spec/fixtures/db/users.json

@@ -0,0 +1,8 @@
+{
+  "users": [
+    {
+      "name": "Jane",
+      "email": "jane@doe.org"
+    }
+  ]
+}

data/spec/fixtures/test_db.json

@@ -0,0 +1,16 @@
+{
+  "users": [
+    {
+      "name": "Jane",
+      "email": "jane@doe.org",
+      "roles": [
+        {
+          "role_name": "Member"
+        },
+        {
+          "role_name": "Admin"
+        }
+      ]
+    }
+  ]
+}

data/spec/integration/adapter_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+require 'rom/lint/spec'
+
+describe 'JSON adapter' do
+  subject(:rom) { setup.finalize }
+
+  let(:root) { Pathname(__FILE__).dirname.join('..') }
+
+  let(:path) { "#{root}/fixtures/test_db.json" }
+  let(:setup) { ROM.setup(:json, path) }
+
+  before do
+    setup.relation(:users) do
+      def by_name(name)
+        restrict(name: name)
+      end
+    end
+
+    setup.mappers do
+      define(:users) do
+        register_as :entity
+
+        model name: 'User'
+
+        attribute :name
+        attribute :email
+
+        embedded :roles, type: :array do
+          attribute :name, from: 'role_name'
+        end
+      end
+    end
+  end
+
+  describe 'env#relation' do
+    it 'returns mapped object' do
+      jane = rom.relation(:users).as(:entity).by_name('Jane').first
+
+      expect(jane.name).to eql('Jane')
+      expect(jane.email).to eql('jane@doe.org')
+      expect(jane.roles.length).to eql(2)
+      expect(jane.roles).to eql([
+        { name: 'Member' }, { name: 'Admin' }
+      ])
+    end
+  end
+
+  describe 'multi-file setup' do
+    it 'uses one-file-per-relation' do
+      setup = ROM.setup(:json, "#{root}/fixtures/db")
+
+      setup.relation(:users)
+      setup.relation(:tasks)
+
+      rom = setup.finalize
+
+      expect(rom.relation(:users)).to match_array([
+        { name: 'Jane', email: 'jane@doe.org' }
+      ])
+
+      expect(rom.relation(:tasks)).to match_array([
+        { title: 'Task One' },
+        { title: 'Task Two' },
+        { title: 'Task Three' }
+      ])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+if RUBY_ENGINE == 'rbx'
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require 'rom-json'
+
+begin
+  require 'byebug'
+rescue LoadError
+end
+
+root = Pathname(__FILE__).dirname
+
+Dir[root.join('shared/*.rb').to_s].each { |f| require f }

data/spec/unit/dataset_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+require 'rom/lint/spec'
+
+describe ROM::JSON::Dataset do
+  let(:data) { [{ id: 1 }, { id: 2 }] }
+  let(:dataset) { ROM::JSON::Dataset.new(data) }
+
+  it_behaves_like "a rom enumerable dataset"
+
+  it "symbolizes keys" do
+    dataset = ROM::JSON::Dataset.new(["foo" => 23])
+    expect(dataset.to_a).to eq([{ foo: 23 }])
+  end
+
+  it "symbolizes keys recursively" do
+    dataset = ROM::JSON::Dataset.new(["foo" => { "bar" => :baz }])
+    expect(dataset.to_a).to eq([foo: { bar: :baz }])
+  end
+end

data/spec/unit/repository_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+require 'rom/lint/spec'
+
+describe ROM::JSON::Gateway do
+  let(:root) { Pathname(__FILE__).dirname.join('..') }
+
+  it_behaves_like 'a rom gateway' do
+    let(:identifier) { :json }
+    let(:gateway) { ROM::JSON::Gateway }
+    let(:uri) { "#{root}/fixtures/test_db.json" }
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: rom-json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Piotr Solnica
+- Rolf Bjaanes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+description: JSON support for Ruby Object Mapper
+email:
+- piotr.solnica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rom-json.rb
+- lib/rom/json.rb
+- lib/rom/json/dataset.rb
+- lib/rom/json/gateway.rb
+- lib/rom/json/relation.rb
+- lib/rom/json/version.rb
+- rakelib/rubocop.rake
+- rom-json.gemspec
+- spec/fixtures/db/tasks.json
+- spec/fixtures/db/users.json
+- spec/fixtures/test_db.json
+- spec/integration/adapter_spec.rb
+- spec/spec_helper.rb
+- spec/unit/dataset_spec.rb
+- spec/unit/repository_spec.rb
+homepage: http://rom-rb.org
+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.5
+signing_key: 
+specification_version: 4
+summary: JSON support for Ruby Object Mapper
+test_files:
+- spec/fixtures/db/tasks.json
+- spec/fixtures/db/users.json
+- spec/fixtures/test_db.json
+- spec/integration/adapter_spec.rb
+- spec/spec_helper.rb
+- spec/unit/dataset_spec.rb
+- spec/unit/repository_spec.rb