objecheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c34dee3669dc8ba5d6da6601f2691dfa1cdf596b23cdb575ce99fec568e84283
+  data.tar.gz: 5a190c9ad765f40ae422a87462134a2066c48497acb63518f2cc63f1cded79e1
+SHA512:
+  metadata.gz: 57c538a3674c233bbf7ba84a6bd0a454b8f0532306d62530adce569b6965143180c60be60e3899064eb671f293d31886ae515d65b6418641e13c66d6ac36f2e0
+  data.tar.gz: df4388871daec2f26406fa2bd91e0c9e9779d70fbef3a8c32a11187bd6effb43f90130dab742c4e094ced95f182356e058a5c2cfbc23b2f8bab1b6a6c20fa3de

data/.circleci/config.yml

@@ -0,0 +1,81 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.4.2-node-browsers
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      # Build gem
+      - run:
+          name: build gem
+          command: |
+            bundle exec rake build
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run unit tests
+      - run:
+          name: run unit tests
+          command: |
+            bundle exec rspec --format documentation
+
+      # run rubocop
+      - run: bundle exec rubocop -D
+
+      # pass workspace to next job
+      - persist_to_workspace:
+          root: .
+          paths:
+            - .
+
+  publish:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.4.2-node-browsers
+    working_directory: ~/repo
+    steps:
+      - attach_workspace:
+          at: .
+      # configure to publish
+      - run:
+          name: configure
+          command: |
+            mkdir ~/.gem && echo -e ":rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials && chmod 0600 /home/circleci/.gem/credentials
+      # publish to rubygems.org
+      - run:
+          name: publish
+          command: |
+            gem push pkg/objecheck-*.gem
+
+workflows:
+  version: 2
+  test-and-deploy:
+    jobs:
+      - build:
+          filters:
+            tags:
+              only: /.*/
+      - publish:
+          requires:
+            - build
+          filters:
+            tags:
+              only: /^v[0-9]+(\.[0-9]+){2}.*/
+            branches:
+              ignore: /.*/

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# bundled files
+/vendor/bundle
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,80 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - bin/*
+    - config/**/*.rb
+    - db/migrate/*.rb
+    - db/schema.rb
+    - db/seeds.rb
+    - vendor/bundle/**/*
+
+Metrics/LineLength:
+  Max: 120
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/MutableConstant:
+  AutoCorrect: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/NegatedWhile:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Max: 15
+  Exclude:
+    - apps/**/views/**/*.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - apps/**/views/**/*.rb
+    - spec/**/*.rb
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Performance/RedundantMerge:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## v0.1.0
+
+First release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in objecheck.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (C) 2018 Akira Tanimura (@AuToPP)
+
+  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,57 @@
+# Objecheck
+
+[![CircleCI](https://circleci.com/gh/autopp/objecheck/tree/master.svg?style=shield)](https://circleci.com/gh/autopp/objecheck/tree/master)
+
+Objecheck provides a simple and extensible object validator
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'objecheck'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install objecheck
+
+## Usage
+
+```ruby
+require 'objecheck'
+
+# Create a validator with rules
+validator = Objecheck::Validator.new({
+  type: Hash
+})
+
+# Validator#validate checks the given object and returns error messages as a array
+p validator.validate({ a: 1, b: 2 }) # => []
+p validator.validate([1, 2]) # => ["root: the type should be a Hash (got Array)"]
+```
+
+## Builtin rules
+
+### `type`
+
+`type` checks that the object is a given class (by `is_a?`).
+
+Example schema:
+```ruby
+{
+  type: Hash
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/autopp/objecheck.
+
+## License
+
+[Apache License 2.0](LICENSE.txt)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'objecheck'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/objecheck/validator/collector.rb

@@ -0,0 +1,40 @@
+#
+# Objecheck
+#
+#    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.
+#
+
+# Collector is used in Validator#validate to aggregate errors
+#
+class Objecheck::Validator::Collector
+  def initialize(validator)
+    @validator = validator
+    @prefix_stack = []
+    @errors = []
+  end
+
+  def add_prefix_in(prefix)
+    @prefix_stack.push(prefix)
+    yield
+  ensure
+    @prefix_stack.pop
+  end
+
+  def add_error(msg)
+    @errors << "#{@prefix_stack.join('')}: #{msg}"
+  end
+
+  def errors
+    @errors.dup
+  end
+end

data/lib/objecheck/validator/type_rule.rb

@@ -0,0 +1,27 @@
+#
+# Objecheck
+#
+#    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.
+#
+
+# TypeRule validates type of a target
+#
+class Objecheck::Validator::TypeRule
+  def initialize(type)
+    @type = type
+  end
+
+  def validate(target, collector)
+    collector.add_error("the type should be a #{@type} (got #{target.class})") if !target.is_a?(@type)
+  end
+end

data/lib/objecheck/validator.rb

@@ -0,0 +1,42 @@
+#
+# Objecheck
+#
+#    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.
+#
+
+# Validator checks a object with given schema and report errors
+#
+class Objecheck::Validator
+  require 'objecheck/validator/type_rule'
+  DEFAULT_RULES = {
+    type: TypeRule
+  }.freeze
+
+  def initialize(schema, rules = DEFAULT_RULES)
+    @rules = schema.map do |rule_name, param|
+      rules[rule_name].new(param)
+    end
+  end
+
+  def validate(target)
+    collector = Collector.new(self)
+    collector.add_prefix_in('root') do
+      @rules.each do |rule|
+        rule.validate(target, collector)
+      end
+    end
+    collector.errors
+  end
+end
+
+require 'objecheck/validator/collector'

data/lib/objecheck.rb

@@ -0,0 +1,22 @@
+#
+# Objecheck
+#
+#    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.
+#
+
+# Objecheck is a top level module of objecheck
+#
+module Objecheck
+end
+
+require 'objecheck/validator'

data/objecheck.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'objecheck'
+  spec.version       = '0.1.0'
+  spec.authors       = ['autopp']
+  spec.email         = ['autopp.inc@gmail.com']
+
+  spec.summary       = 'schema and validator for a Ruby object'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/autopp/objecheck'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: objecheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- autopp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: schema and validator for a Ruby object
+email:
+- autopp.inc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/objecheck.rb
+- lib/objecheck/validator.rb
+- lib/objecheck/validator/collector.rb
+- lib/objecheck/validator/type_rule.rb
+- objecheck.gemspec
+homepage: https://github.com/autopp/objecheck
+licenses:
+- Apache-2.0
+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.7.3
+signing_key: 
+specification_version: 4
+summary: schema and validator for a Ruby object
+test_files: []