jimmy 0.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a62e54e6b0658797c8fb7c6ca16d2a59f68b53ef
-  data.tar.gz: bdb3b25cfb2ae06ad970e9f577c64bab1400ef4e
+SHA256:
+  metadata.gz: 445cebab8aa679190116902608361938ced57a678a878ff03dc8fb15182ffc55
+  data.tar.gz: 9c9cc22906573a9b311cc92e61a3fd584736a9b4e2aa468060d147b6f7f4c50f
 SHA512:
-  metadata.gz: 7dc6cf3628f02163eaaa2a946ef8daaecd20afedc422d1635499b32b2982563b89a07963a4325be5656c54c9183740c45aab39196f1d6370ab4dd18743af9de2
-  data.tar.gz: b6c6880288081fdc4a1739ff389739bd8d6e21853caeb3598a314cbd3bb1d0ebdf3383e23b9a30cd39d9df8c9189ad579e886da45a48893cf054c511b14be641
+  metadata.gz: '018afef0aa32e99fb30b3413107e50022df0edd72ac85f62d8be0c9fc376ff48232da2988f63dc26134a80c86ffbbe4284d33f1cba3420cb29a62c0a5bcbcbf3'
+  data.tar.gz: eff46b385b6b20d30c8c424fe8c8df39868cdfc214cad90628a78dd822eea17a8bd3281b2d450c637d6c8b270fb1dca07e0ce0449a5c9294365116ecf581d539

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+jobs:
+  specs:
+    docker:
+      - image: cimg/ruby:2.6
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install --with ci
+      - run:
+          name: RSpec
+          command: bundle exec rspec --format documentation --format RspecJunitFormatter --out /tmp/rspec.xml
+      - store_test_results:
+          path: /tmp/rspec.xml
+
+  lint:
+    docker:
+      - image: cimg/ruby:2.6
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install --with ci
+      - run:
+          name: RSpec
+          command: bundle exec rubocop
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - specs
+      - lint

data/.gitignore

@@ -1,11 +1,12 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-.rspec
-*.gem
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,61 @@
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+# See https://docs.rubocop.org/en/stable/
+
+AllCops:
+  NewCops: enable
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/LineLength:
+  Max: 80
+  IgnoredPatterns:
+    - '\A\s*# {3}' # Examples in YARD
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Naming/MethodParameterName:
+  AllowedNames: ['as', 'id']
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/Documentation:
+  Exclude:
+    - spec/**/*_spec.rb
+    - lib/jimmy/schema/**/*.rb
+    - lib/jimmy/declaration/**/*.rb
+
+Style/DocumentationMethod:
+  Enabled: true
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.1.5
+2.6.3

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at neil.pearson@bigcommerce.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,3 +1,16 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+# Specify your gem's dependencies in jimmy.gemspec
 gemspec
+
+gem 'json_schemer', '~> 0.2.11'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.9'
+gem 'rubocop', '0.84'
+gem 'simplecov', '~> 0.18.5'
+
+group :ci do
+  gem 'rspec_junit_formatter', '~> 0.4.1'
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 OrionVM Pty Ltd
+Copyright 2015–2020 Neil E. Pearson
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,151 +1,39 @@
-# Jimmy the Gem
+# Jimmy
 
-Meet your mate Jimmy. He's a top bloke.
+Version 2 of the Ruby gem for making JSON schemas the nice way.
 
-Writing JSON schemas is as tedious as a tax audit. But now, thanks to everyone's new best friend Jimmy, it's easier than shooting the side of a barn with a very easy-to-use projectile weapon.
+[![CircleCI](https://circleci.com/gh/hx/jimmy/tree/master.svg?style=svg)](https://circleci.com/gh/hx/jimmy)
 
-## Getting hooked up
+## Installation
 
-You guessed it:
+Add this line to your application's Gemfile:
 
-```bash
-$ gem install jimmy
+```ruby
+gem 'jimmy'
 ```
 
-Here's another doozy:
+And then execute:
 
-```ruby
-require 'jimmy'
-```
+    $ bundle install
 
-Wasn't that a shock. Let's move on.
+Or install it yourself as:
 
-## The DSL
+    $ gem install jimmy
 
-Jimmy replaces `.json` JSON schemas files with `.rb` files. Here's a simple example:
+## Usage
 
-```ruby
-# city.rb
-object do
-  string :name, min_length: 2
-  string :postcode, /^\d{4}$/
+Check the [docs](https://rubydoc.info/gems/jimmy).
 
-  require all
-end
-```
+## Development
 
-This compiles to:
-
-```json
-{
-  "$schema": "https://my.domain.kom/city#",
-  "type": "object",
-  "properties": {
-    "name": {
-      "type": "string",
-      "minLength": 2
-    },
-    "postcode": {
-      "type": "string",
-      "pattern": "^\\d{4}$"
-    },
-    "required": ["name", "zipcode"],
-    "additionalProperties": false
-  }
-}
-```
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-Crikey! That's a bit of a difference. Let's take a look at a more complex (and contrived) example:
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-```ruby
-# types/country_code.rb
-string /^[A-Z]{2}$/
-
-# types/geopoint.rb
-object do
-  number :latitude, -90..90
-  number :longitude, -180..180
-end
-
-# city.rb
-object do
-  string :name, min_length: 2
-  string :postcode, /^\d{4}$/
-  integer :population
-  geopoint :location
-  country_code :country
-  array :points_of_interest do
-    object do
-      string :title, 3..150
-      integer :popularity, [1, 3, 5, 7]
-      geopoint :location
-      boolean :featured
-      require :title
-    end
-  end
-  require all - :location
-end
-```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hx/jimmy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hx/jimmy/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
 
-Here's the full result (though we expect you get the gist of it by now):
-
-```json
-{
-  "$schema": "https://my.domain.kom/city#",
-  "type": "object",
-  "properties": {
-    "name": {
-      "type": "string",
-      "minLength": 2
-    },
-    "postcode": {
-      "type": "string",
-      "pattern": "^\\d{4}$"
-    },
-    "population": {
-      "type": "integer"
-    },
-    "location": {
-      "$ref": "/types/geopoint#"
-    },
-    "country": {
-      "$ref": "/types/country_code#"
-    },
-    "points_of_interest": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "title": {
-            "type": "string",
-            "minLength": 3,
-            "maxLength": 150
-          },
-          "popularity": {
-            "type": "integer",
-            "enum": [1, 3, 5, 7]
-          },
-          "location": {
-            "$ref": "/types/geopoint#"
-          },
-          "featured": {
-            "type": "boolean"
-          }
-        },
-        "required": [
-          "title"
-        ],
-        "additionalProperties": false
-      }
-    }
-  },
-  "required": [
-    "name",
-    "postcode",
-    "population",
-    "country",
-    "points_of_interest"
-  ],
-  "additionalProperties": false
-}
-```
+Everyone interacting in the Jimmy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hx/jimmy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,4 +1,94 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new :spec
+require 'tempfile'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+# rubocop:disable all
+class Documentator
+  DELIMITER = '# Generated by `rake yard`. Do not modify anything below here.'
+
+  def self.update(path, &block)
+    new(path).update(&block)
+  end
+
+  def initialize(path)
+    @path = Jimmy::ROOT.join(*path)
+  end
+
+  def update(&block)
+    @indent = ''
+    mute    = false
+
+    File.foreach(@path) do |line|
+      if line.match? /^#{@indent}(class|module) /
+        @indent += '  '
+      elsif line == @indent + DELIMITER + "\n"
+        mute = true
+        render &block
+      elsif line == @indent[0..-3] + "end\n"
+        render "\n", &block unless mute
+        mute = false
+      end
+      write line unless mute
+    end
+
+    tempfile.close
+    @path.unlink
+    File.rename tempfile.path, @path.to_s
+  rescue
+    tempfile.unlink
+    raise
+  end
+
+  def <<(str)
+    lines = str.lines
+    lines.each { |line| write "#{@indent}# #{line}" }
+  end
+
+  private
+
+  def write(line)
+    tempfile.write line
+  end
+
+  def render(prefix = '')
+    write "%s%s%s\n%s#\n" % [prefix, @indent, DELIMITER, @indent]
+    yield self
+  end
+
+  def tempfile
+    @tempfile ||= Tempfile.new('documented')
+  end
+end
+# rubocop:enable all
+
+desc 'Generate YARD for some runtime-defined methods'
+task :yard do
+  require 'jimmy'
+
+  Documentator.update %w[lib jimmy declaration string.rb] do |y|
+    Jimmy::Declaration::FORMATS.each do |format|
+      y << <<~YARD
+        @!method #{format.gsub '-', '_'}()
+          Validate a string with format "#{format}".
+          @return [Schema]
+      YARD
+    end
+  end
+
+  Documentator.update %w[lib jimmy declaration types.rb] do |y|
+    Jimmy::Declaration::SIMPLE_TYPES.each do |type|
+      y << <<~YARD
+        @!method #{type}()
+          Make the schema allow type "#{type}".
+          @return [Schema]
+      YARD
+    end
+  end
+end