tiny_struct 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 758264eb4fc3bc300e1b10ca9189795d8e2174b0
+  data.tar.gz: aa152037cc0e94e9d01f122020766d7e52fe85b1
+SHA512:
+  metadata.gz: 74379e8af24b9361e1a8308ca4309384d6dfab9c1272280eed3327810ff4cd84ee6c002b38117871a25ace233d8eb7c49875daf0a6f4b92a722708d61ca1d1da
+  data.tar.gz: 04caf65066d4717adf629ea998c766811d5b378d7ffd3cdbf38b63f3af6092703a5f38864b51c4b94cc23b651a6bff2c55256bee086e772557ae1cae2f591511

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.4
+  Exclude:
+  - 'vendor/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm: 2.4.2
+cache: bundler
+script:
+- bundle exec rake
+- bundle exec rubocop

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    tiny_struct (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    docile (1.1.5)
+    json (2.1.0)
+    minitest (5.10.3)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.2.1)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  minitest (~> 5.10)
+  rake (~> 12.2)
+  rubocop (~> 0.51)
+  simplecov (~> 0.15)
+  tiny_struct!
+
+BUNDLED WITH
+   1.16.0.pre.3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kevin Deisz
+
+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,72 @@
+# TinyStruct
+
+[![Build Status](https://travis-ci.org/kddeisz/tiny_struct.svg?branch=master)](https://travis-ci.org/kddeisz/tiny_struct)
+
+Build `Struct` classes that do less. `TinyStruct` is a very similar concept to `Struct` classes in Ruby, with a few key differences:
+
+* In `Struct` classes all parameters are optional, in `TinyStruct` they are all required.
+* In `Struct` classes each parameter is accessible through an `attr_accessor`, in `TinyStruct` they are accessible through `attr_reader`s.
+* In `Struct` classes you can call all kinds of querying methods on the objects as if they were an enumerable of the various values they represent (e.g., `to_a`, `to_h`, `size`, `[]`, `values_at`, etc.), in `TinyStruct` none of these methods are defined.
+
+Use `Struct` if you need the flexibility and extra query methods provided by the constructor. If not, consider using `TinyStruct`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tiny_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tiny_struct
+
+## Usage
+
+### Basic usage
+
+Build `TinyStruct` classes like so:
+
+```ruby
+class User < TinyStruct.new(:first_name, :last_name)
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+end
+```
+
+Now you can build `User` objects like so:
+
+```ruby
+user = User.new('Kevin', 'Deisz')
+# => #<User @first_name="Kevin" @last_name="Deisz">
+```
+
+### Configuration
+
+`TinyStruct` by default will cache each of the classes that is constructed through `TinyStruct::new` in order to deduplicate potential new classes with those that are already constructed. This cache is by default stored in memory. If you're worried about memory performance and don't mind taking a hit to performance, you can turn this off (and have it instead just loop through `ObjectSpace`) by doing the following before you configure anything:
+
+```ruby
+TinyStruct.configure do |config|
+  config.cache = false
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/tiny_struct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tiny_struct'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/tiny_struct.rb

@@ -0,0 +1,101 @@
+require 'tiny_struct/memory_cache'
+require 'tiny_struct/object_space_cache'
+require 'tiny_struct/version'
+
+# A class for encompassing the simple pattern of required and ordered parameters
+# and their associated reader methods. To create a new class, run:
+#
+#     class User < TinyStruct.new(:first_name, :last_name)
+#       def full_name
+#         "#{first_name} #{last_name}"
+#       end
+#     end
+#
+# This will create a class that now has `attr_reader`s for `first_name` and
+# `last_name`, as well as having an initializer that sets those values.
+class TinyStruct
+  ATTRIBUTE_PATTERN = /\A[a-z][a-zA-Z0-9_]*\z/
+
+  # `true` if the members of the other `TinyStruct` instance are equal to
+  # the values of this `TinyStruct` instance.
+  def eql?(other)
+    other.class.respond_to?(:members) &&
+      self.class.members == other.class.members &&
+      self.class.members.all? do |attribute|
+        public_send(attribute) == other.public_send(attribute)
+      end
+  end
+  alias == eql?
+
+  def inspect
+    pairs =
+      self.class.members.map { |name| "@#{name}=#{public_send(name).inspect}" }
+    "#<#{self.class.name || 'TinyStruct'} #{pairs.join(' ')}>"
+  end
+  alias to_s inspect
+
+  class << self
+    attr_accessor :cache
+
+    # Builds a new `TinyStruct` subclass based on the given members. The
+    # given members must be symbols that represents names that could
+    # otherwise be used as argument names.
+    def new(*members)
+      success =
+        members.all? do |attribute|
+          attribute.is_a?(Symbol) && attribute.match?(ATTRIBUTE_PATTERN)
+        end
+
+      unless success
+        raise ArgumentError, 'arguments to TinyStruct::new must be valid ' \
+                             'attribute names represented as symbols'
+      end
+
+      class_cache[members] ||= define_class(members)
+    end
+
+    # Yields `TinyStruct` to a block such that you can toggle configuration
+    # settings. For example:
+    #
+    #     TinyStruct.configure do |config|
+    #       config.cache = false
+    #     end
+    def configure
+      yield self
+    end
+
+    private
+
+    def define_class(members)
+      clazz =
+        Class.new(TinyStruct) do
+          attr_reader(*members)
+          define_singleton_method(:new, Object.method(:new))
+          define_singleton_method(:members) { members }
+        end
+
+      define_initialize_method(clazz, members)
+      clazz
+    end
+
+    def define_initialize_method(clazz, members)
+      clazz.send(:define_method, :initialize) do |*arguments|
+        if members.size != arguments.size
+          message = "wrong number of arguments (given #{arguments.size}, " \
+                    "expected #{members.size})"
+          raise ArgumentError, message
+        end
+
+        members.zip(arguments).each do |name, value|
+          instance_variable_set(:"@#{name}", value)
+        end
+      end
+    end
+
+    def class_cache
+      @class_cache ||= cache ? MemoryCache.new : ObjectSpaceCache.new
+    end
+  end
+
+  self.cache = true
+end

data/lib/tiny_struct/memory_cache.rb

@@ -0,0 +1,24 @@
+class TinyStruct
+  # Maintains an in-memory cache of the defined `TinyStruct` classes, such that
+  # classes with the same attribute list do not end up getting created twice.
+  #
+  # This cache makes performance quite a bit better since looping through
+  # `ObjectSpace` takes a while, but takes a hit on memory because everything
+  # is now stored. Also prevents the classes from being freed if they were
+  # created anonymously and could have otherwise have been freed.
+  class MemoryCache
+    attr_reader :cache
+
+    def initialize
+      @cache = {}
+    end
+
+    def []=(members, clazz)
+      cache[members] = clazz
+    end
+
+    def [](members)
+      cache[members]
+    end
+  end
+end

data/lib/tiny_struct/object_space_cache.rb

@@ -0,0 +1,16 @@
+class TinyStruct
+  # Allows for finding previously constructed `TinyStruct` classes that contain
+  # a certain set of members so that they do not end up getting created twice.
+  #
+  # This cache saves some on space because we're not storing them in memory,
+  # but takes a slight hit to performance whenever a new class in defined.
+  class ObjectSpaceCache
+    def []=(*); end
+
+    def [](members)
+      ObjectSpace.each_object(TinyStruct.singleton_class).detect do |clazz|
+        clazz != TinyStruct && clazz.members == members
+      end
+    end
+  end
+end

data/lib/tiny_struct/version.rb

@@ -0,0 +1,3 @@
+class TinyStruct
+  VERSION = '0.0.1'.freeze
+end

data/tiny_struct.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tiny_struct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tiny_struct'
+  spec.version       = TinyStruct::VERSION
+  spec.authors       = ['Kevin Deisz']
+  spec.email         = ['kevin.deisz@gmail.com']
+
+  spec.summary       = 'Build Struct classes that do less.'
+  spec.homepage      = 'https://github.com/kddeisz/tiny_struct'
+  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', '~> 1.16.a'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'rake', '~> 12.2'
+  spec.add_development_dependency 'rubocop', '~> 0.51'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: tiny_struct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Deisz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 
+email:
+- kevin.deisz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tiny_struct.rb
+- lib/tiny_struct/memory_cache.rb
+- lib/tiny_struct/object_space_cache.rb
+- lib/tiny_struct/version.rb
+- tiny_struct.gemspec
+homepage: https://github.com/kddeisz/tiny_struct
+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: Build Struct classes that do less.
+test_files: []