ks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f36c29feda7f2d5ef40f578461982bfc9d1b19d3
+  data.tar.gz: 1b15cad80b3bdfa52af0f482096c0eae77836c0b
+SHA512:
+  metadata.gz: bc92b6fc8685faea432f14c1953e2191fa963231bd2260966b49d9849198b43b333717fad75ac870a334764cfcba3cf0d0ac0f4a0cc9618fd67b4410c5c0de87
+  data.tar.gz: 20768fa163981bc152fdd424a7946e7709e4bbe6344ba3a9a3969a3195d0937ba8d8837a142a2ca8e234750e5c6780f69e1426df0bea9d096574cdbc3aab2bad

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 WeTransfer
+
+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,33 @@
+# ks - a generator for keyworded Structs
+
+Normally when you create a Struct in Ruby you get a positional arguments
+initializer.
+
+    S = Struct.new(:a, :b)
+    S.new(1, 2)
+
+This gem allows for creation of Structs that accept keyword arguments in the same way.
+
+    S = Ks.strict(:a, :b)
+    S.new(a: 1, b: 2)
+
+The resulting Struct will complain if you omit some keyword arguments, and will take care
+of handling them for you as well. The generated classes are cached and the created
+initializer is inserted in a class between your descendant and the Struct subclass
+itself. If you want defaults, use a `Module#prepend` or `Module#include` solution,
+or just call `super` with some keyword arguments set to their defaults.
+
+## Contributing to ks
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 WeTransfer. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+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 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ks #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/ks.rb

@@ -0,0 +1,43 @@
+require 'thread'
+require 'set'
+
+# "Ks" - as in "kiss" - a generator of keyworded Structs.
+module Ks
+  VERSION = '0.0.1'
+  
+  @@caching_mutex = Mutex.new
+  @@predefined_structs = {}
+  
+  # Returns a class that is a descendant of Struct, with a strict
+  # keyword initializer.
+  #
+  #     Info = Ks.strict(:item_count, :weight)
+  #     data = Info.new(item_count: 1, weight: 2)
+  #
+  # 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
+  #
+  # @param members[Array<Symbol>] the names of members to create
+  # @return created_class[Class]
+  def self.strict(*members)
+    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
+          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

data/spec/ks_spec.rb

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,9 @@
+$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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: ks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Keyword-initialized Structs
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ks.rb
+- spec/ks_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wetransfer/ks
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []