ruby-obj 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee90a0b8dbce2e44efb1efc814cc6eec5dc90966
+  data.tar.gz: 9d57124f917b6d266020d2886aa547024397a023
+SHA512:
+  metadata.gz: aeaf1e1455c904936fb76ef31c363c13adb0a8932f55114324e875d604071ae29bc5c1bec55a37725906623d2591067c331aac2bb283b30fdd42ea8f1e342a52
+  data.tar.gz: 3624e4d3ee608dbf3d44a930913d36611a72dd23c80fd28d2350514907e737f2ccd4c69874d46d093e70abcb68979b88df8280e13a24a30ca911d1131a62533c

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2019 Sven Fuchs <me@svenfuchs.com>
+
+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,68 @@
+# Obj
+
+A Struct replacement that allows default arguments, and omits the
+hash-style API that Struct implements.
+
+## Installation
+
+```
+gem install ruby-obj
+```
+
+## Usage
+
+```ruby
+class One < Obj.new(:one, two: :default)
+end
+
+obj = One.new(1)
+obj.one  # => 1
+obj.one? # => true
+obj.two  # => :default
+obj.two? # => true
+
+obj = One.new(nil)
+obj.one? # => false
+```
+
+Modules included to `Obj` are propagated to all instances:
+
+```ruby
+module Foo
+  def foo
+  end
+end
+
+Obj.include(Foo)
+
+class One < Obj.new(:one)
+end
+
+one = One.new(1)
+one.respond_to?(:foo) # => true
+```
+
+# Benchmark
+
+`Obj` is marginally slower than `Struct` (which is implemented in C):
+
+```ruby
+require 'benchmark'
+require 'obj'
+
+n = 1_000_000
+
+str = Struct.new(:foo)
+obj = Obj.new(:foo)
+
+Benchmark.bm(10) do |b|
+  b.report('str:') { n.times { str.new(:foo).foo } }
+  b.report('obj:') { n.times { obj.new(:foo).foo } }
+end
+```
+
+```
+                 user     system      total        real
+str:         0.180000   0.000000   0.180000 (  0.174254)
+obj:         0.180000   0.000000   0.180000 (  0.181985)
+```

data/lib/obj.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+class Obj
+  class << self
+    def include(*modules)
+      super
+      includes.concat(modules)
+    end
+
+    def includes
+      @includes ||= []
+    end
+
+    def new(*attrs, &block)
+      defaults = attrs.last.is_a?(Hash) ? attrs.pop : {}
+
+      Class.new do
+        include *Obj.includes if Obj.includes.any?
+
+        args = attrs + defaults.map(&->(pair) { '%s = %p' % pair })
+        init = attrs.map(&->(name) { '@%s = %s' % [name, name] })
+        init = init + defaults.map(&->(pair) { '@%s = %s || %p' % [pair.first, *pair] })
+
+        class_eval %(
+          def initialize(#{args.join(', ')})
+            #{init.join("\n")}
+          end
+        )
+
+        attrs.concat(defaults.keys).each do |attr|
+          attr_accessor *attr
+          define_method(:"#{attr}?") { !!send(attr) }
+        end
+
+        class_eval &block if block
+      end
+    end
+  end
+end

data/lib/obj/version.rb

@@ -0,0 +1,3 @@
+module Obj
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: ruby-obj
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sven Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-22 00:00:00.000000000 Z
+dependencies: []
+description: Struct replacement with argument defaults.
+email:
+- me@svenfuchs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/obj.rb
+- lib/obj/version.rb
+homepage: https://github.com/svenfuchs/obj
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Struct replacement with argument defaults
+test_files: []