dystruct 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15cdb1d06c10d11c3f0374a7de03941ac4669ab0
+  data.tar.gz: 2771045a37aa81359ac1973e1bd116684a237abc
+SHA512:
+  metadata.gz: ab19fc8bb08aa374d4a6d1e2b830ad21998c00fe9457cc500d9e58af71373475de2fed4ae00015eaa55e70bcd602cfa204bdd5a381f2073798266c4dc454edbd
+  data.tar.gz: 78d77bdfdf9f13b15f4d4273b3c7af283b8b1c69bd12d2fd2ace78b4e5889d514dd7eb5612c19e5be06a7e3619fee802d968c7a6c6ae9b952fb81476f54ef2c2

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dystruct.gemspec
+gemspec
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Artur Pañach
+
+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,172 @@
+# Dystruct
+
+Better Structs for many applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dystruct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dystruct
+
+## Usage
+
+__Extended OpenStruct:__
+
+```ruby
+  context = Dystruct.new(name: 'John', surname: 'Doe')
+  context.name # => 'John'
+  context.name_provided? # => true
+  context.surname # => 'Doe'
+  context.foo_provided? # => false
+  context.foo_not_provided? # => true
+  context.foo = :bar
+  context.foo_provided? # => true
+  context.foo_not_provided? # => false
+  context.foo # => :bar
+  context.to_h # => {:name=>"John", :surname=>"Doe", :foo=>:bar}
+```
+
+_more complex example_
+```ruby
+class Input < Dystruct
+  permit  :name, :city, :address, :phone_number, :free_text, :country_code,
+    :country, :zip, :types
+  defaults types: ['lodging']
+  aliases :name, :hotel_name
+  aliases :phone_number, :telephone
+
+  def long_name
+    [name, address, city].join(', ')
+  end
+
+  def types
+    Array.wrap(args[:types])
+  end
+end
+
+i = Input.new(name: 'Hotel', city: 'Barcelona', address: 'Happy street', not_permitted: 'dangerous')
+i.types
+# => ["lodging"]
+i.long_name
+# => "Hotel, Happy street, Barcelona"
+i.name
+# => "Hotel"
+i.hotel_name
+# => "Hotel"
+i.phone_number_provided?
+# => false
+i.not_permitted
+# => NoMethodError: undefined method
+```
+
+### Building better Structs
+
+**no_method_error**
+```ruby
+class Example < Dystruct
+  no_method_error false
+end
+
+Example.new(foo: :bar).hello # => nil
+```
+
+```ruby
+class Example < Dystruct
+  no_method_error
+end
+
+Example.new(foo: :bar).hello # => => NoMethodError: undefined method
+```
+
+**required**
+```ruby
+class Example < Dystruct
+  required :required_arg
+end
+
+Example.new(foo: :bar)
+#=> Error Dystruct::RequiredFieldNotPresent
+```
+
+**aliases**
+```ruby
+class Example < Dystruct
+  aliases :hello, :greeting, :welcome
+end
+ex = Example.new(hello: 'Hey!')
+# => #<Example:0x007fd88ba30398 @args={:hello=>"Hey!"}>
+ex.hello
+# => "Hey!"
+ex.greeting
+# => "Hey!"
+ex.welcome
+# => "Hey!"
+```
+
+**defaults**
+```ruby
+class Example2 < Dystruct
+  defaults foo: :bar, bar: :foo
+end
+ex = Example2.new
+ex.foo
+# => :bar
+ex.bar
+# => :foo
+ex.foo = :hello
+ex.foo
+# => :hello
+
+ex2 = Example2.new(foo: 'something', bar: true)
+ex2.foo
+# => 'something'
+ex2.bar
+# => true
+```
+
+**ensure_presence**
+```ruby
+class EnsurePresence < Dystruct
+  ensure_presence :foo
+end
+EnsurePresence.new(hello: 'asdf')
+#=> Error: Dystruct::PresenceRequired
+
+EnsurePresence.new(foo: nil)
+#=> Error: Dystruct::PresenceRequired
+
+EnsurePresence.new(foo: '').foo #=> ""
+```
+
+**permit**
+```ruby
+per = Permit.new(foo: :bar, hello: 'Hey!', bar: 'bla', yuju: 'dangerous')
+ => #<Permit:0x007fd88b9dd878 @args={:foo=>:bar, :hello=>"Hey!"}>
+per.foo #=> :bar
+per.yuju #=> nil
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/arturictus/dystruct. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+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 "dystruct"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dystruct.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dystruct'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dystruct"
+  spec.version       = Dystruct::VERSION
+  spec.authors       = ["Artur Pañach"]
+  spec.email         = ["arturictus@gmail.com"]
+  spec.summary       = %q{Structs with steroids.}
+  spec.description   = %q{Better way to improve your data structs.}
+  spec.homepage      = "https://www.github.com/arturictus/dystruct"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/dystruct.rb

@@ -0,0 +1,72 @@
+class Dystruct
+  VERSION = "0.4.0"
+  autoload :ClassMethods, 'dystruct/class_methods'
+  autoload :InstanceMethods, 'dystruct/instance_methods'
+
+  class RequiredFieldNotPresent < ArgumentError; end
+  class PresenceRequired < ArgumentError; end
+  class WrongArgument < ArgumentError; end
+
+  def self.inherited(subclass)
+    subclass.extend ClassMethods
+    subclass.include InstanceMethods
+  end
+
+  attr_reader :attrs
+  alias_method :to_h, :attrs
+  alias_method :to_hash, :attrs
+
+  def initialize(hash = {})
+    unless hash.class <= Hash
+      fail WrongArgument, "[Dystruct ERROR]: `#{self.class}` expects to receive a `Hash` or and object having `Hash` as ancestor."
+    end
+    @attrs = hash
+    @attrs.each do |k, v|
+      define_dystruct_method(k, v)
+    end
+  end
+
+  def [](key)
+    attrs[key]
+  end
+
+  def []=(key, value)
+    set_attribute(key, value)
+  end
+
+  def method_missing(name, *args, &block)
+    if name =~ /\A\w+=\z/
+      set_attribute_macro(name, *args, &block)
+    elsif out = provided_macro(name)
+      out[:out]
+    else
+      super
+    end
+  end
+
+  private
+
+  def set_attribute_macro(name, *args, &block)
+    value = args.first || block
+    key = name.to_s.gsub('=', '').to_sym
+    set_attribute(key, value)
+  end
+
+  def provided_macro(name)
+    case name.to_s
+    when /\A\w+_not_provided\?\z/ then { out: true }
+    when /\A\w+_provided\?\z/ then { out: false }
+    end
+  end
+
+  def set_attribute(key, value)
+    attrs[key] = value
+    define_dystruct_method(key, value)
+  end
+
+  def define_dystruct_method(key, value)
+    define_singleton_method(key) { attrs.fetch(key) }
+    define_singleton_method("#{key}_provided?") { true }
+    define_singleton_method("#{key}_not_provided?") { false }
+  end
+end

data/lib/dystruct/class_methods.rb

@@ -0,0 +1,37 @@
+class Dystruct
+  module ClassMethods
+
+    def settings
+      @settings ||= {}
+    end
+
+    def required(*names)
+      settings[:required] = names.map(&:to_sym)
+    end
+
+    def no_method_error(input = true)
+      settings[:no_method_error] = input
+    end
+
+    def open_struct_behavior(input = true)
+      settings[:no_method_error] = !input
+    end
+
+    def ensure_presence(*names)
+      settings[:presence_required] = names.map(&:to_sym)
+    end
+
+    def aliases(*names)
+      settings[:equivalents] ||= []
+      settings[:equivalents] << names.map(&:to_sym)
+    end
+
+    def defaults(hash)
+      settings[:defaults] = hash
+    end
+
+    def permit(*names)
+      settings[:permitted] = names.map(&:to_sym)
+    end
+  end
+end

data/lib/dystruct/instance_methods.rb

@@ -0,0 +1,95 @@
+class Dystruct
+  module InstanceMethods
+    def initialize(hash = {})
+      check_input_errors(hash)
+      hash = hash.select{|k, v| _permitted.include?(k.to_sym) } if _only_permitted?
+      @attrs = _defaults.merge(hash)
+      attrs.each do |k, v|
+        define_dystruct_method(k, v)
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      if ary = find_in_equivalents(name)
+        _from_equivalents(ary)
+      elsif name =~ /\A\w+=\z/
+        set_attribute_macro(name, *args, &block)
+      else
+        out = provided_macro(name)
+        return out[:out] if out
+        if _no_method_error
+          super
+          # raise NoMethodError, "Method not found for #{self.class}: `#{name}`"
+        end
+      end
+    end
+
+    def find_in_equivalents(name)
+      found = nil
+      _equivalents.each do |ary|
+        found = ary if ary.include?(name.to_sym)
+        break if found
+      end
+      found
+    end
+
+    def _from_equivalents(ary)
+      out = nil
+      ary.each do |method|
+        out = attrs[method.to_sym]
+        break if out
+      end
+      out
+    end
+
+    def _only_permitted?
+      _permitted.any?
+    end
+
+    def _permitted
+      _get_config[:permitted] || []
+    end
+
+    def _equivalents
+      _get_config[:equivalents] || []
+    end
+
+    def _presence_required
+      _get_config[:presence_required] || []
+    end
+
+    def _no_method_error
+      _get_config[:no_method_error].nil? ? true : _get_config[:no_method_error]
+    end
+
+    def _defaults
+      _get_config[:defaults] || {}
+    end
+
+    def _required_args
+      _get_config[:required] || []
+    end
+
+    def _get_config
+      self.class.settings
+    end
+
+    def check_input_errors(hash)
+      unless hash.class <= Hash
+        fail WrongArgument, "[Dystruct ERROR]: `#{self.class}` expects to receive a `Hash` or and object having `Hash` as ancestor."
+      end
+
+      _required_args.map(&:to_sym).each do |r|
+        unless hash.keys.map(&:to_sym).include?(r)
+          fail RequiredFieldNotPresent, "[Dystruct ERROR]: `#{self.class}` expect to be initialized with `#{r}` as an attribute."
+        end
+      end
+
+      _presence_required.map(&:to_sym).each do |r|
+        if hash[r].nil?
+          fail PresenceRequired, "[Dystruct ERROR]: `#{self.class}` expects to receive an attribute named `#{r}` not beeing `nil`"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: dystruct
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Artur Pañach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: Better way to improve your data structs.
+email:
+- arturictus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dystruct.gemspec
+- lib/dystruct.rb
+- lib/dystruct/class_methods.rb
+- lib/dystruct/instance_methods.rb
+homepage: https://www.github.com/arturictus/dystruct
+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.3
+signing_key: 
+specification_version: 4
+summary: Structs with steroids.
+test_files: []