easy_json_matcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aac9b53dc002894d4415c88923b7f544248cd5b0
+  data.tar.gz: f349d7f0b70b34acf537985638f92a97c7a3d27f
+SHA512:
+  metadata.gz: bb28de637e864eb7288282cdeb00dff395c7590bb392fdf108a75b086e6fa8ad215359256cddbee96753678648d8232ec95e0e2b93435498aea1c7b976b9d80f
+  data.tar.gz: cb7da7f775d5d35786f54f9de63d3cbdfb0ac3dae8e42293abd9ee6fa39b8d622d674985ffa9b6ec09eb97c622aaf2fc10cc36dc0695a235d0928c50814191d5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 WJD Hamilton
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JsonapiMatcher'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/easy_json_matcher/array_validator.rb

@@ -0,0 +1,8 @@
+require 'easy_json_matcher/validator'
+module EasyJSONMatcher
+  class ArrayValidator < Validator
+    def _validate
+      content.is_a? Array
+    end
+  end
+end

data/lib/easy_json_matcher/boolean_validator.rb

@@ -0,0 +1,9 @@
+require 'easy_json_matcher/validator'
+module EasyJSONMatcher
+  class BooleanValidator < Validator
+    def _validate
+      clazz = content.class
+      (clazz == TrueClass) || (clazz == FalseClass)
+    end
+  end
+end

data/lib/easy_json_matcher/content_wrapper.rb

@@ -0,0 +1,18 @@
+module EasyJSONMatcher
+  class ContentWrapper
+
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+
+    def [](key)
+      content[key.to_s]
+    end
+
+    def method_missing(method, *args)
+      content.send(method, *args)
+    end
+  end
+end

data/lib/easy_json_matcher/date_validator.rb

@@ -0,0 +1,35 @@
+require 'easy_json_matcher/validator'
+module EasyJSONMatcher
+  class DateValidator < Validator
+
+    attr_reader :string_validator, :date_format
+    DEFAULT_DATE_FORMAT = "%Y-%m-%d"
+
+    def initialize(opts = {})
+      super(opts)
+      @date_format = opts[:format]
+      @string_validator = ValidatorFactory.create({type: :string})
+    end
+
+    def _validate
+      _validate_as_string && _validate_as_date
+    end
+
+    def _validate_as_string
+      string_validator.valid? content
+    end
+
+    def _validate_as_date
+      require 'date'
+      begin
+        Date.strptime(content, date_format)
+      rescue ArgumentError
+        false
+      end
+    end
+
+    def date_format
+      @date_format || DEFAULT_DATE_FORMAT
+    end
+  end
+end

data/lib/easy_json_matcher/node.rb

@@ -0,0 +1,64 @@
+require 'easy_json_matcher'
+require 'easy_json_matcher/validator_factory'
+require 'json'
+require 'easy_json_matcher/content_wrapper'
+require 'forwardable'
+module EasyJSONMatcher
+  class Node < Validator
+    extend Forwardable
+
+    attr_reader :validators
+
+    def_delegators :content, :[]
+
+    def initialize(opts: {})
+      super(options: opts)
+      @validators = []
+    end
+
+    def add_validator(validator)
+      validators << validator
+    end
+
+    def _validate
+      validators.each do |val|
+        return false unless _use_validator val
+      end
+      true
+    end
+
+    def _use_validator(validator)
+      validator.valid? self
+    end
+
+    def _get_content_for(key)
+      content[key.to_s]
+    end
+
+    def _get_validator_for(key)
+      validators[key]
+    end
+
+    def _set_content(candidate)
+      candidate = _prep_candidate(candidate)
+      @content = _is_root? ? candidate : candidate[key]
+    end
+
+    def _is_root?
+      key.nil?
+    end
+
+    def _prep_candidate(json)
+      if json.is_a? String
+        wrap_content(JSON.parse(json))
+      else
+        raise "Content for validation must be either a Hash or a String - you supplied #{json}, which is a #{json.class.name}" unless json.respond_to? :[]
+        wrap_content(json)
+      end
+    end
+
+    def wrap_content(json)
+      ContentWrapper.new(json)
+    end
+  end
+end

data/lib/easy_json_matcher/number_validator.rb

@@ -0,0 +1,15 @@
+# Asserts that a value is a double-precision floating point number in javascript format
+require 'easy_json_matcher/validator'
+module EasyJSONMatcher
+  class NumberValidator < Validator
+    def _validate
+      begin
+        Kernel::Float(content)
+        true
+      rescue ArgumentError => e
+        false
+      end
+    end
+
+  end
+end

data/lib/easy_json_matcher/object_validator.rb

@@ -0,0 +1,8 @@
+require 'easy_json_matcher/validator'
+module EasyJSONMatcher
+  class ObjectValidator < Validator
+    def _validate
+      content.is_a? Hash
+    end
+  end
+end

data/lib/easy_json_matcher/schema_generator.rb

@@ -0,0 +1,49 @@
+require 'easy_json_matcher/validator_factory'
+require 'easy_json_matcher/node'
+module EasyJSONMatcher
+  class SchemaGenerator
+
+    attr_reader :node
+    attr_reader :name
+
+    def initialize(opts: {})
+      @name = opts[:key]
+      yield self if block_given?
+    end
+
+    def contains_node(key:, opts: {})
+      generator = _node_generator validator_opts(key, opts)
+      yield generator if block_given?
+      node.add_validator generator.generate_node
+    end
+
+    def has_attribute(key:, opts: {})
+      node.add_validator(_create_validator(validator_opts(key, opts)))
+    end
+
+    def validator_opts(key, opts)
+      opts[:key] = key
+      opts
+    end
+
+    def _create_validator(opts)
+      ValidatorFactory.create opts
+    end
+
+    def _node_generator(opts = {})
+     self.class.new opts: opts
+    end
+
+    def generate_node
+      node
+    end
+
+    def register(schema_name:)
+      EasyJSONMatcher.add_schema(name: schema_name, schema: generate_node)
+    end
+
+    def node
+      @node ||= Node.new(opts: validator_opts(name, {}))
+    end
+  end
+end

data/lib/easy_json_matcher/string_validator.rb

@@ -0,0 +1,10 @@
+require 'easy_json_matcher/validator'
+module EasyJSONMatcher
+  class StringValidator < Validator
+
+  def _validate
+    content.is_a? String
+  end
+
+  end
+end

data/lib/easy_json_matcher/validation_error.rb

@@ -0,0 +1,8 @@
+module EasyJSONMatcher
+  class ValidationError < Error
+
+    def initialize(error_details)
+      super(error_details)
+    end
+  end
+end

data/lib/easy_json_matcher/validator.rb

@@ -0,0 +1,19 @@
+module EasyJSONMatcher
+  class Validator
+
+    attr_reader :content, :key
+
+    def initialize(options: {})
+      @key = options[:key]
+    end
+
+    def valid?(candidate)
+      _set_content(candidate)
+      _validate
+    end
+
+    def _set_content(candidate)
+      @content = key ? candidate[key.to_s] : candidate
+    end
+  end
+end

data/lib/easy_json_matcher/validator_factory.rb

@@ -0,0 +1,71 @@
+require 'easy_json_matcher/object_validator'
+require 'easy_json_matcher/string_validator'
+require 'easy_json_matcher/number_validator'
+require 'easy_json_matcher/date_validator'
+require 'easy_json_matcher/boolean_validator'
+require 'easy_json_matcher/array_validator'
+require 'easy_json_matcher/value_validator'
+module EasyJSONMatcher
+  class ValidatorFactory
+
+    class << self
+      def create(opts)
+        validator_class = get_type(opts[:type])
+        validator_class.new options: opts
+      end
+
+      def get_type(name)
+        case name
+        when nil
+          default_validator
+        when :object
+          object_validator
+        when :string
+          string_validator
+        when :number
+          number_validator
+        when :date
+          date_validator
+        when :boolean
+          boolean_validator
+        when :array
+          array_validator
+        when :value
+          value_validator
+        end
+      end
+
+      def default_validator
+        object_validator
+      end
+
+      def object_validator
+        ObjectValidator
+      end
+
+      def string_validator
+        StringValidator
+      end
+
+      def number_validator
+        NumberValidator
+      end
+
+      def date_validator
+        DateValidator
+      end
+
+      def boolean_validator
+        BooleanValidator
+      end
+
+      def array_validator
+        ArrayValidator
+      end
+
+      def value_validator
+        ValueValidator
+      end
+    end
+  end
+end

data/lib/easy_json_matcher/value_validator.rb

@@ -0,0 +1,8 @@
+require 'easy_json_matcher/validator'
+module EasyJSONMatcher
+  class ValueValidator < Validator
+    def _validate
+      true
+    end
+  end
+end

data/lib/easy_json_matcher/version.rb

@@ -0,0 +1,3 @@
+module JsonapiMatcher
+  VERSION = "0.0.1"
+end

data/lib/easy_json_matcher.rb

@@ -0,0 +1,27 @@
+require 'easy_json_matcher/node'
+require 'easy_json_matcher/schema_generator'
+module EasyJSONMatcher
+
+    SCHEMAS = {}
+    private_constant :SCHEMAS
+  class << self
+    def available_schemas
+      schemas.keys
+    end
+
+    def schema_for(name)
+      schemas[name]
+    end
+
+    def add_schema(name:, schema:)
+      schemas[name] = schema
+    end
+
+    def schemas
+      SCHEMAS
+    end
+  end
+
+  # Override of Ruby error for namespacing
+  class Error < RuntimeError; end
+end

data/lib/tasks/jsonapi_matcher_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :easy_json_matcher do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "easy_json_matcher"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!