safe_values 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba03abf1ce02d1e319edf07d93dfdd9c95c7985a03085a964b75159672483143
+  data.tar.gz: 1aa9bb295da60cca721fdbb3c8826399845159c4ea5ef7364e3c1cd999494b20
+SHA512:
+  metadata.gz: 5848e9df32a06a5a611f8bdc6cc47f1ffec2edcd989c10a834fbaa57588b0a42d73df9f327fd8776fe4c8e2772b8e785f32653ebc713d861ed4d8c84ff044017
+  data.tar.gz: 7b830c4a56c889e7c64cfeb7bfabfcdc3a90b6b53c27fb99d621ef3cf7e4e1accd745ecaf2e26a19031a19d98b171aa4873797f6eada6c384b2a96cfcb76aef2

data/.circleci/config.yml

@@ -0,0 +1,94 @@
+version: 2.1
+
+executors:
+  ruby:
+    parameters:
+      ruby-version:
+        type: string
+        default: "2.6"
+      gemfile:
+        type: string
+        default: "Gemfile"
+    docker:
+      - image: circleci/ruby:<< parameters.ruby-version >>
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+          RAILS_ENV: test
+          BUNDLE_GEMFILE: << parameters.gemfile >>
+
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+    executor:
+      name: ruby
+      ruby-version: << parameters.ruby-version >>
+    parallelism: 1
+    steps:
+      - checkout
+
+      - run:
+          # Remove the non-appraisal gemfile for safety: we never want to use it.
+          name: Prepare bundler
+          command: bundle -v
+
+      - run:
+          name: Compute a gemfile lock
+          command: bundle lock && cp "${BUNDLE_GEMFILE}.lock" /tmp/gem-lock
+
+      - restore_cache:
+          keys:
+            - safe_values-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
+            - safe_values-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      - save_cache:
+          key: safe_values-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: bundle exec rspec --profile 10 --format RspecJunitFormatter --out test_results/rspec.xml --format progress
+
+      - store_test_results:
+          path: test_results
+
+  publish:
+    executor: ruby
+    steps:
+       - checkout
+       - run:
+           name: Setup Rubygems
+           command: |
+             mkdir ~/.gem &&
+             echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials &&
+             chmod 0600 ~/.gem/credentials
+       - run:
+           name: Publish to Rubygems
+           command: |
+             gem build safe_values.gemspec
+             gem push safe_values-*.gem
+
+workflows:
+  version: 2.1
+  build:
+    jobs:
+      - test:
+          name: 'ruby 2.5'
+          ruby-version: "2.5"
+      - test:
+          name: 'ruby 2.6'
+          ruby-version: "2.6"
+      - publish:
+          filters:
+            branches:
+              only: master
+            tags:
+              ignore: /.*/

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+dist: trusty
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+before_install:
+  # Travis' Ruby 2.5.0 ships broken rubygems, won't run rake.
+  # Workaround: update rubygems. See travis-ci issue 8978
+  - gem install bundler
+notifications:
+  email: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 DMM.com
+
+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,35 @@
+# SafeValues
+[![Build Status](https://travis-ci.org/iknow/safe_values.svg?branch=master)](https://travis-ci.org/iknow/safe_values)
+
+`Value` generates `Struct` classes with safer constructors. It is designed to
+provide a superset of the interface of the `Values` gem, with better
+performance, by subclassing actual native `Struct`s.
+
+`Value` constructors require all mandatory arguments to be provided, and supply
+default values for all optional arguments. Additionally, the resulting instance
+is frozen. To obtain a mutable `Value`, use `dup`.
+
+`Value` types are created similarly to `Struct`s, with the addition that
+optional arguments are may be specified as keyword arguments:
+
+```ValueType = Value.new(:a, :b, c: default_value)```
+
+The default values to optional arguments are saved at class creation time and
+supplied as default constructor arguments to instances. Default values are
+aliased, so providing mutable defaults is discouraged.
+
+Two instance constructors are provided, with positional and keyword arguments.
+
+Value types may be constructed with positional arguments using `new`. Arguments
+are provided in the same order as specified at class initialization time, with
+mandatory arguments before optional ones. For example:
+
+```ValueType.new(1, 2)```
+or
+```ValueType.new(1, 2, 3)```
+
+Value types may be constructed with keyword arguments using `with`. For example:
+
+```ValueType.with(a: 1, b: 2)```
+or
+```ValueType.with(a: 1, b: 2, c: 3)```

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+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 "safe_values"
+
+# 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/safe_values.rb

@@ -0,0 +1,5 @@
+require "safe_values/version"
+require "value"
+
+module SafeValues
+end

data/lib/safe_values/version.rb

@@ -0,0 +1,3 @@
+module SafeValues
+  VERSION = "1.0.1"
+end

data/lib/value.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# `Value` generates `Struct` classes with safer constructors. It is designed to
+# provide a superset of the interface of the `Values` gem, with better
+# performance, by subclassing actual native Structs.
+#
+# `Value` constructors require all mandatory arguments to be provided, and
+# supply default values for all optional arguments. Additionally, the resulting
+# instance is frozen. To obtain a mutable Value, `dup` the result.
+#
+# `Value` structure classes are created similarly to `Struct`s, with the
+# addition that optional arguments are may be specified as keyword arguments:
+# `ValueType = Value.new(:a, :b, c: default_value)`. The default values to
+# optional arguments are saved at class creation time and supplied as default
+# constructor arguments to instances. Default values are aliased, so providing
+# mutable defaults is discouraged.
+#
+# Two instance constructors are provided, with positional and keyword arguments.
+#
+# Value types may be constructed with positional arguments using `new`.
+# Arguments are provided in the same order as specified at class initialization
+# time, with mandatory arguments before optional ones.
+# For example: `ValueType.new(1, 2)`, `ValueType.new(1, 2, 3)`
+#
+# Value types may be constructed with keyword arguments using `with`.
+# For example: `ValueType.with(a: 1, b: 2, c: 3)`
+class Value < Struct
+  class << self
+    def new(*required_args, **optional_args, &block)
+      arguments = {}
+      required_args.each { |arg| arguments[arg] = true }
+      optional_args.each_key { |arg| arguments[arg] = false }
+      validate_names(*arguments.keys)
+
+      clazz = super(*arguments.keys, &nil)
+
+      # define class and instance methods in modules so that the class can
+      # override them
+      keyword_constructor = generate_keyword_constructor(arguments)
+      class_method_module = Module.new do
+        module_eval(keyword_constructor)
+        define_method(:__constructor_default) do |name|
+          optional_args.fetch(name)
+        end
+      end
+      clazz.extend(class_method_module)
+
+      constructor = generate_constructor(arguments)
+      instance_method_module = Module.new do
+        module_eval(constructor)
+      end
+      clazz.include(instance_method_module)
+
+      # Evaluate the block in the context of the class
+      clazz.class_eval(&block) if block_given?
+
+      clazz
+    end
+
+    private
+
+    def validate_names(*params)
+      params.each do |param|
+        unless param.is_a?(Symbol) && param =~ /\A[a-z_][a-zA-Z_0-9]*\z/
+          raise ArgumentError.new("param #{param} is not a valid identifier")
+        end
+      end
+    end
+
+    # Generates an initialize method with required and optional parameters,
+    # delegating to the Struct constructor. Parameter names must have already
+    # been validated.
+    #
+    # For a Value.new(:a, b: x), will define the method:
+    #
+    # def initialize(a, b = self.class.__constructor_default(:b))
+    #   super(a, b)
+    #   freeze
+    # end
+    def generate_constructor(arguments)
+      params = arguments.map do |arg_name, required|
+        if required
+          arg_name
+        else
+          "#{arg_name} = self.class.__constructor_default(:#{arg_name})"
+        end
+      end
+
+      <<-SRC
+        def initialize(#{params.join(", ")})
+          super(#{arguments.keys.join(", ")})
+          freeze
+        end
+      SRC
+    end
+
+    # Generates an alternative construction method accepting keyword arguments
+    # for required and optional parameters, delegating to the generated
+    # constructor. Parameter names must have already been validated.
+    #
+    # For a Value.new(:a, b: x), will define the (class) method:
+    #
+    # def with(a:, b: __constructor_default(:b))
+    #   self.new(a, b)
+    # end
+    def generate_keyword_constructor(arguments)
+      params = arguments.map do |arg_name, required|
+        if required
+          "#{arg_name}:"
+        else
+          "#{arg_name}: __constructor_default(:#{arg_name})"
+        end
+      end
+
+      <<-SRC
+        def with(#{params.join(", ")})
+          self.new(#{arguments.keys.join(", ")})
+        end
+      SRC
+    end
+  end
+
+  def with(hash = {})
+    return self if hash.empty?
+    self.class.with(to_h.merge(hash))
+  end
+end

data/safe_values.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safe_values/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'safe_values'
+  spec.version       = SafeValues::VERSION
+  spec.authors       = ['DMM Eikaiwa']
+  spec.email         = ['dev@iknow.jp']
+
+  spec.summary       = %q{Struct classes with safer constructors.}
+  spec.homepage      = 'http://github.com/iknow/safe_values'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: safe_values
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- DMM Eikaiwa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !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: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dev@iknow.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safe_values.rb
+- lib/safe_values/version.rb
+- lib/value.rb
+- safe_values.gemspec
+homepage: http://github.com/iknow/safe_values
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Struct classes with safer constructors.
+test_files: []