ks 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f36c29feda7f2d5ef40f578461982bfc9d1b19d3
-  data.tar.gz: 1b15cad80b3bdfa52af0f482096c0eae77836c0b
+  metadata.gz: 6ac4b409cd2da70b14d2bd80734bcec3cbb69e3a
+  data.tar.gz: 8766f1ce550dd060e7cc27997974f1a4eecdd846
 SHA512:
-  metadata.gz: bc92b6fc8685faea432f14c1953e2191fa963231bd2260966b49d9849198b43b333717fad75ac870a334764cfcba3cf0d0ac0f4a0cc9618fd67b4410c5c0de87
-  data.tar.gz: 20768fa163981bc152fdd424a7946e7709e4bbe6344ba3a9a3969a3195d0937ba8d8837a142a2ca8e234750e5c6780f69e1426df0bea9d096574cdbc3aab2bad
+  metadata.gz: c5fd595264b15cb35fa9d6ef0b6269c7ca79910df4cc65d02fd73e53a7c7180a2b5b6cf91bce83de035f9e15fabc48bf73b73c4ee935de9315fb01d943804244
+  data.tar.gz: a15d78f2e7340bb1013152b7146832eb2fd30e51c5b98f357be1dcbe1c1c6bc74210cd7d4cbb22c3b3228e3fec930dbdbc292052d96e5c0a1c4caa4d7ee28177

data/.gitignore

@@ -0,0 +1,50 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  wetransfer_style: ruby/default.yml
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: false
+Layout/FirstMethodParameterLineBreak:
+  Enabled: false
+Style/GlobalVars:
+  Exclude:
+      - qa/*.rb
+      - spec/spec_helper.rb

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+- 2.1.5
+- 2.2.2
+sudo: false
+cache: bundler

data/Gemfile

@@ -1,8 +1,5 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
 
-group :development do
-  gem "rspec", "~> 3.2.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2.0.1"
-end
+source 'http://rubygems.org'
+
+gemspec

data/Rakefile

@@ -1,51 +1,18 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require_relative 'lib/ks'
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.version = Ks::VERSION
-  gem.name = "ks"
-  gem.homepage = "http://github.com/wetransfer/ks"
-  gem.license = "MIT"
-  gem.description = %Q{Keyword-initialized Structs}
-  gem.description = %Q{Keyword-initialized Structs}
-  gem.email = "me@julik.nl"
-  gem.authors = ["Julik Tarkhanov"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
+require 'yard'
+require 'rubocop/rake_task'
 
-desc "Code coverage detail"
-task :simplecov do
-  ENV['COVERAGE'] = "true"
-  Rake::Task['spec'].execute
+YARD::Rake::YardocTask.new(:doc) do |t|
+  # The dash has to be between the two to "divide" the source files and
+  # miscellaneous documentation files that contain no code
+  t.files = ['lib/**/*.rb', '-', 'LICENSE.txt', 'IMPLEMENTATION_DETAILS.md']
 end
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+RuboCop::RakeTask.new(:rubocop)
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "ks #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task default: %i[spec rubocop]

data/ks.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ks'
+
+Gem::Specification.new do |spec|
+  spec.name           = 'ks'
+  spec.version        = Ks::VERSION
+  spec.authors        = ['Julik Tarkhanov']
+  spec.email          = ['me@julik.nl']
+
+  spec.summary        = 'Keyword-initialized Structs'
+  spec.description    = 'Keyword-initialized Structs'
+  spec.homepage       = 'http://github.com/WeTransfer/ks'
+
+  # Prevent pushing this gem to RubyGems.org.
+  # To allow pushes either set the 'allowed_push_host'
+  # To allow pushing to a single host or delete
+  # this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  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', '~> 1'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'wetransfer_style', '0.6.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/lib/ks.rb

@@ -1,13 +1,14 @@
-require 'thread'
+# frozen_string_literal: true
+
 require 'set'
 
 # "Ks" - as in "kiss" - a generator of keyworded Structs.
 module Ks
-  VERSION = '0.0.1'
-  
+  VERSION = '0.0.2'
+
   @@caching_mutex = Mutex.new
   @@predefined_structs = {}
-  
+
   # Returns a class that is a descendant of Struct, with a strict
   # keyword initializer.
   #
@@ -17,9 +18,10 @@ module Ks
   # Note that all the keyword arguments defined for the class (all the members)
   # are going to be required keyword arguments for the initializer.
   #
-  # The created classes (Struct descendants) are cached to make reloading easier,
-  # since when reloading a usual Struct descendant it will receive a different parent
-  # class. This is mitigated by caching the created subclasses using their member lists
+  # The created classes (Struct descendants) are cached
+  # to make reloading easier, since when reloading a usual Struct
+  # descendant it will receive a different parent class.
+  # This is mitigated by caching the created subclasses using their member lists
   #
   # @param members[Array<Symbol>] the names of members to create
   # @return created_class[Class]
@@ -27,7 +29,7 @@ module Ks
     k = members.sort.join(':')
     @@caching_mutex.synchronize do
       return @@predefined_structs[k] if @@predefined_structs[k]
-      
+
       struct_ancestor = Struct.new(*members)
       predefined = Class.new(struct_ancestor) do
         class_eval <<-METHOD, __FILE__, __LINE__ + 1
@@ -40,4 +42,49 @@ module Ks
       predefined
     end
   end
+
+  # Returns a class that is a descendant of Struct, with a
+  # keyword initializer that permits unknown keywords to be passed in.
+  # Those keywords will be dropped. The keywords that are known at
+  # definition time will be checked for presence. This allows you to
+  # use structs for API responses and payloads that might get additional
+  # properties as the API evolves, without breaking (your) consuming
+  # code. Imagine at time of designing your structures you specify a
+  # Shipment:
+  #
+  #     Shipment = Ks.allowing_unknown(:sku, :weight)
+  #
+  # The API you are using, however, later adds a "shipping_company_id"
+  # property. If you had used `strict` your struct would fail to initialize,
+  # since it does not know about the `shipping_company_id` attribute.
+  #
+  #    Shipment.new(JSON.parse(payload)) #=> ArgumentError...
+  #
+  # but as you have used `allowing_unknown` the "shipping_company_id" property
+  # will be silently dropped instead.
+  #
+  # The created classes (Struct descendants) are cached
+  # to make reloading easier, since when reloading a usual Struct
+  # descendant it will receive a different parent class.
+  # This is mitigated by caching the created subclasses using their member lists
+  #
+  # @param members[Array<Symbol>] the names of members to create. Those members will be required, just like with `Ks.strict`
+  # @return created_class[Class]
+  def self.allowing_unknown(*members)
+    k = 'with_optionals:' + members.sort.join(':')
+    @@caching_mutex.synchronize do
+      return @@predefined_structs[k] if @@predefined_structs[k]
+
+      struct_ancestor = Struct.new(*members)
+      predefined = Class.new(struct_ancestor) do
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def initialize(#{members.map { |a| "#{a}:" }.join(', ')}, **) # def initialize(bar:, baz:, **)
+            super(#{members.join(', ')})                                #   super(bar, baz)
+          end                                                           # end
+        METHOD
+      end
+      @@predefined_structs[k] = predefined
+      predefined
+    end
+  end
 end

metadata

@@ -1,92 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: ks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '12'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: wetransfer_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0.9'
 description: Keyword-initialized Structs
-email: me@julik.nl
+email:
+- me@julik.nl
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
 - ".document"
+- ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- ks.gemspec
 - lib/ks.rb
-- spec/ks_spec.rb
-- spec/spec_helper.rb
-homepage: http://github.com/wetransfer/ks
-licenses:
-- MIT
-metadata: {}
+homepage: http://github.com/WeTransfer/ks
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -103,8 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Keyword-initialized Structs
 test_files: []

data/spec/ks_spec.rb

@@ -1,28 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Ks" do
-  describe '.strict' do
-    it "allocates a Struct class that can be initialized with keywords" do
-      k = Ks.strict(:foo, :bar)
-      item = k.new(foo: 1, bar: 2)
-      expect(item.foo).to eq(1)
-      expect(item.bar).to eq(2)
-      expect(item.class.ancestors).to include(Struct)
-      expect(item.members).to eq([:foo, :bar])
-    end
-    
-    it 'raises when keyword arguments are omitted' do
-      k = Ks.strict(:foo, :bar)
-      expect {
-        k.new(foo: 1)
-      }.to raise_error(ArgumentError, 'missing keyword: bar')
-    end
-    
-    it 'caches the created Struct ancestor even when using multiple threads' do
-      classes = (1..12).map do
-        Thread.new { Ks.strict(:one, :another) }
-      end.map(&:join).map(&:value)
-      expect(classes.uniq.length).to eq(1)
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'rspec'
-require 'ks'
-
-RSpec.configure do |config|
-  config.order = 'random'
-end