randrizer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be06076a3c75b00ab51471e44ef3f7b6794423f9c5dbe4f9ff9b01efb4493fb6
-  data.tar.gz: cea424a0ca6abd167ec418afbb7952c346304252f1da937f13d5eb85373ade6c
+  metadata.gz: b25e9cd95d331a6443f7b4773a8a0d762b5a874f9924212fb4a42bfd9416b1d6
+  data.tar.gz: d3ba8f10a4e122ff123576715ede100d88f521b7834468f9e2a444fad6f296f4
 SHA512:
-  metadata.gz: 656b7243cc9ac2be824c6060a27ed88940316f57a5acd93140b3a99043283443130bc34b774c9ed0e43867beb6b54cf941dbebf46b1509b114dad37b4d30be41
-  data.tar.gz: c5ca2206521f575429fbf281d45072f3025ba3ec5c367d971c55663209db339b7f7f0d8b173f3db1a0ceac4b6b3c6058bf162457523761138227d2ba1030b7ba
+  metadata.gz: 6260ab5766c17cd475ec5946faa1d5038fa4ea900afa1707226875bd09ae2ab91f053a63b76d3e9c7a8e084b389236af22bb929689db01db086ef211ef440ce6
+  data.tar.gz: 5f9481bd7bc97be037ded292ec46ddd32b7c02cdb4ddaaee41ab0a61fb39a0e354be17fbd90d2b0a3cec70282a1e57047c29e09ccac02db9aea7041834795276

data/.circleci/config.yml

@@ -0,0 +1,63 @@
+version: 2
+
+references:
+  install_bundle: &install_bundle
+    run:
+      name: Bundle
+      command: gem install bundler -v 2.1.4 && bundle install --path vendor/bundle --jobs=4 --retry=3
+
+  restore_bundle_cache: &restore_bundle_cache
+    restore_cache:
+      key: randrizer-{{ checksum "randrizer.gemspec" }}
+
+  save_bundle_cache: &save_bundle_cache
+    save_cache:
+      key: randrizer-{{ checksum "randrizer.gemspec" }}
+      paths:
+        - vendor/bundle
+
+  steps: &steps
+    - checkout
+    - *install_bundle
+    - *restore_bundle_cache
+    - *save_bundle_cache
+    - run:
+        name: RSpec
+        command: bundle exec rspec --format progress --format RspecJunitFormatter -o tmp/rspec-reports/unit.xml $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+
+jobs:
+  code_quality:
+    docker:
+      - image: circleci/ruby:2.7.0
+    steps:
+      - checkout
+      - *restore_bundle_cache
+      - *install_bundle
+      - *save_bundle_cache
+      - run:
+          name: Rubocop
+          command: bundle exec rubocop
+
+  tests-r2.5:
+    docker:
+      - image: circleci/ruby:2.5.7
+    steps: *steps
+
+  tests-r2.6:
+    docker:
+      - image: circleci/ruby:2.6.5
+    steps: *steps
+
+  tests-r2.7:
+    docker:
+      - image: circleci/ruby:2.7.0
+    steps: *steps
+
+workflows:
+  version: 2
+  tests:
+    jobs:
+      - code_quality
+      - tests-r2.5
+      - tests-r2.6
+      - tests-r2.7

data/.gitignore

@@ -2,10 +2,11 @@
 
 .data/
 .bundle/
+doc/
 log/
 tmp/
 .idea/
-
+.yardoc/
 .rspec_status
 
 .local_files

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.6.5
+  TargetRubyVersion: 2.7.0
   DisplayCopNames: true
   DisplayStyleGuide: true
   ExtraDetails: true
@@ -10,7 +10,7 @@ AllCops:
     - vendor/**/*
     - bin/**/*
 
-Lint/UnneededCopDisableDirective:
+Lint/RedundantCopDisableDirective:
   Severity: error
 
 Lint/AmbiguousBlockAssociation:
@@ -32,7 +32,7 @@ Metrics/ClassLength:
 Metrics/MethodLength:
   Max: 58
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 90
   Exclude:
     - 'Gemfile'
@@ -59,15 +59,24 @@ Style/StringLiterals:
   Exclude:
     - Gemfile
 
-Layout/IndentFirstArrayElement:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
 Style/YodaCondition:
   Enabled: true
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 RSpec/ExampleLength:
   Enabled: false
 
@@ -96,7 +105,7 @@ RSpec/ContextWording:
     - for
     - and
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     # These are the default allowed names, set by Rubocop
     - io

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/lib/randrizer.rb

@@ -2,4 +2,3 @@
 
 require "randrizer/version"
 require "randrizer/types"
-require "randrizer/drivers/json_schema"

data/lib/randrizer/cli.rb

@@ -2,6 +2,7 @@
 
 require "randrizer/version"
 require "randrizer"
+require "randrizer/drivers/json_schema"
 
 module Randrizer
   class Cli

data/lib/randrizer/drivers/json_schema/driver.rb

@@ -33,7 +33,7 @@ module Randrizer
             root_type = attrs["type"]
             value_type = gen_value_type(root_type, attrs)
 
-            unless required_keys.include?(key_type)
+            unless required_keys.include?(key)
               key_type = Types::Optional[inner_type: key_type]
             end
 

data/lib/randrizer/types/base_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "ruby2_keywords"
+require "randrizer/types/type_validation_error"
+
+module Randrizer
+  module Types
+    class BaseType
+      def initialize(*args, **kwargs, &block); end
+
+      # @raise [TypeValidationError] if the arguments given to the type are not valid
+      def validate!
+        raise NotImplementedError
+      end
+
+      class << self
+        # Required for compatibility with Ruby <= 2.6. See
+        # https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
+        ruby2_keywords def build(*args, &block)
+          new(*args, &block)
+        end
+
+        alias [] build
+      end
+    end
+  end
+end

data/lib/randrizer/types/bool.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class Bool
-      include TypeBuilder
-
+    # A boolean type. Can be either `true` or `false`.
+    class Bool < BaseType
       PRESENCE_MAYBE = 0.5
 
       def initialize(true_prob: PRESENCE_MAYBE)

data/lib/randrizer/types/const.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class Const
-      include TypeBuilder
-
+    # A constant type. Any type passed as argument will be returned as given.
+    class Const < BaseType
       def initialize(params)
         @params = params
       end

data/lib/randrizer/types/dict.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 require "randrizer/types/skip"
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class Dict
-      include TypeBuilder
-
+    class Dict < BaseType
       def initialize(keys_def)
         @keys_def = keys_def
       end

data/lib/randrizer/types/float.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class Float
-      include TypeBuilder
-
+    class Float < BaseType
       DEFAULT_MIN = 0.0
       DEFAULT_MAX = 9_999_999_999.0
 

data/lib/randrizer/types/int.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class Int
-      include TypeBuilder
-
+    # A primitive integer type. The evaluation will generate a random number between
+    # the given `min` and `max`.
+    class Int < BaseType
+      # Default minimum generable number
       DEFAULT_MIN = 0
+
+      # Default maximum generable number
       DEFAULT_MAX = 9_999_999_999
 
       def initialize(min: DEFAULT_MIN, max: DEFAULT_MAX)

data/lib/randrizer/types/list.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 require "randrizer/types/skip"
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class List
-      include TypeBuilder
-
+    class List < BaseType
       def initialize(list_def)
         @list_def = list_def
       end

data/lib/randrizer/types/nullable.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class Nullable
-      include TypeBuilder
-
+    class Nullable < BaseType
       def initialize(null_prob:, inner_type:)
         @null_prob = null_prob
         @inner_type = inner_type

data/lib/randrizer/types/one_of.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class OneOf
-      include TypeBuilder
-
+    class OneOf < BaseType
       def initialize(list_def)
         @list_def = list_def
       end

data/lib/randrizer/types/optional.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 require "randrizer/types/skip"
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class Optional
-      include TypeBuilder
-
+    class Optional < BaseType
       PRESENCE_MAYBE = 0.5
 
       def initialize(inner_type:, presence_prob: PRESENCE_MAYBE)

data/lib/randrizer/types/skip.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "randrizer/types/base_type"
+
 module Randrizer
   module Types
-    class Skip
+    class Skip < BaseType
       def ==(other)
         other.class == Skip
       end

data/lib/randrizer/types/string.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class String
-      include TypeBuilder
-
+    class String < BaseType
       CHARS_NUMBERS = "0123456789"
       CHARS_SYMBOLS = " !\"£$%^&()=-*/[]#\\~"
       CHARS_LOWERCASE_LETTERS = "abcdfeghijklmnopqrstuvwxyz"

data/lib/randrizer/types/string_sequence.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require "randrizer/types/type_builder"
+require "randrizer/types/base_type"
 
 module Randrizer
   module Types
-    class StringSequence
-      include TypeBuilder
-
+    class StringSequence < BaseType
       ALLOWED_TYPES = [
         Types::Int,
         Types::String,

data/lib/randrizer/types/type_validation_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Randrizer
+  module Types
+    class TypeValidationError < StandardError; end
+  end
+end

data/lib/randrizer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Randrizer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/randrizer.gemspec

@@ -24,10 +24,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "ruby2_keywords", "~> 0.0.2"
+
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "pry-byebug", "~> 3.7.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.8.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "redcarpet", "~> 3.5.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.75.0"
-  spec.add_development_dependency "rubocop-rspec", "~> 1.36.0"
+  spec.add_development_dependency "rspec_junit_formatter", "0.4.1"
+  spec.add_development_dependency "rubocop", "~> 0.80.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.38.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: randrizer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ivan Giuliani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -30,28 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.80.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.38.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.38.1
 description: Random data generator with type composition
 email:
 - giuliani.v@gmail.com
@@ -102,9 +144,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".yardopts"
 - Gemfile
 - LICENCE.txt
 - README.md
@@ -116,6 +160,7 @@ files:
 - lib/randrizer/drivers/json_schema/typegen.rb
 - lib/randrizer/generator.rb
 - lib/randrizer/types.rb
+- lib/randrizer/types/base_type.rb
 - lib/randrizer/types/bool.rb
 - lib/randrizer/types/const.rb
 - lib/randrizer/types/dict.rb
@@ -128,7 +173,7 @@ files:
 - lib/randrizer/types/skip.rb
 - lib/randrizer/types/string.rb
 - lib/randrizer/types/string_sequence.rb
-- lib/randrizer/types/type_builder.rb
+- lib/randrizer/types/type_validation_error.rb
 - lib/randrizer/version.rb
 - randrizer.gemspec
 homepage: https://github.com/ivgiuliani/randrizer

data/lib/randrizer/types/type_builder.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Randrizer
-  module Types
-    module TypeBuilder
-      class ValidationError < StandardError; end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      def validate!
-        raise NotImplementedError
-      end
-
-      module ClassMethods
-        def build(*args, **params)
-          new(*args, **params)
-        end
-
-        alias [] build
-      end
-    end
-  end
-end