attributary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ebdff0c364b0480e2c79d90df50064f2b015400
+  data.tar.gz: cef7eccd653b8c77ea68aa3f08a40ab89787ab63
+SHA512:
+  metadata.gz: 0aa7ee051f7a870076ff468b1f6b1a9b4ab91a1342e2e3c5f876c3fb7a024affd4b8a3b279cc933a2a340161444082f9702025a4d6b4e725d3682f747a707e51
+  data.tar.gz: d13c1daefa1c490e0a9fe70ac1dfbb626c477525716013bf1467212688b7c1f72b17821b857fa7679b5c05a730db844da493fa8923464e5556181199ee56a3b3

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in attributary.gemspec
+gemspec

data/README.md

@@ -0,0 +1,127 @@
+# Attributary
+
+Like `ActiveModel::Attributes` but not. No dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attributary'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attributary
+
+## Usage
+
+### Configuration
+
+    Attributary.configure do |c|
+      c.dsl_name = :donkey # defaults to :attrubute
+      c.strict_mode = false # set this to `true` to skip casting in the writer method (raises TypeError)
+    end
+    
+### Actually using it
+
+    class Character
+      include Attributary::DSL
+      
+      donkey :gender, :symbol, default: :male 
+    end
+     
+    character = Character.new
+    puts character.gender # :male 
+    character.gender = 'female'
+    puts character.gender # :female
+
+### Initializing
+
+Want to initialize? Cool.
+
+    class Character
+      include Attributary::Initializer
+      include Attributary::DSL
+      
+      donkey :gender, :symbol, default: :male 
+    end
+    
+    character = Character.new(gender: :male)
+    puts character.gender # :male 
+    
+Have to initialize other stuff? Send a hash to attributary_initialize
+
+    class Character
+      include Attributary::Initializer
+      include Attributary::DSL
+      
+      donkey :gender, :symbol, default: :male 
+      
+      def initialize(name, attributary_attributes = {})
+        @name = name 
+        attributary_initialize(attributary_attributes)
+      end  
+    end
+    
+    character = Character.new("Charlie", gender: :male)
+    puts character.gender # :male 
+
+### Validations
+
+There are two types of validations. You can pass a `:collection` option, and/or you can pass a `:validates` option.
+
+#### Using `:collection`
+
+Simply pass an array of the possible options for the attribute.
+
+    class Character
+      include Attributary::DSL
+      
+      donkey :gender, :symbol, default: :male, collection: [:male, :female]
+    end
+    
+    character = Character.new("Charlie", gender: :male)
+    puts character.gender # :male 
+    character.gender = :left # raises CollectionValidationError
+    character.gender = :female 
+    puts character.gender # :female 
+    character.gender = 'male' # gets casted correctly, and doesn't raise an error. Turn this off with strict_mode
+    
+#### Using `:validates`
+
+Pass a proc or a method name.
+
+    class Character
+      include Attributary::DSL
+      
+      donkey :gender, :symbol, default: :male, validates: proc { |value| [:male, :female].include?(value) }
+    end
+    
+    character = Character.new("Charlie", gender: :male)
+    puts character.gender # :male 
+    character.gender = :left # raises CollectionValidationError
+    character.gender = 'female' # gets casted correctly, and doesn't raise an error
+    
+
+### Types
+
+Supports some really naive typecasting. [See the supported types](https://github.com/joshmn/attributary/tree/master/lib/attributary/types). Create your own by inheriting from `Attributary::Types` and naming it like `ClassNameType`
+
+    module Attributary
+      module Types
+        class FriendType < Type
+          def self.cast_to(value)
+            Foe.new(value)
+          end
+        end
+      end
+    end
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshmn/attributary

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/attributary.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attributary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'attributary'
+  spec.version       = Attributary::VERSION
+  spec.authors       = ['Josh Brody']
+  spec.email         = ['josh@josh.mn']
+
+  spec.summary       = 'Like ActiveModel::Attributes but less fluffy and more attribute-y.'
+  spec.description   = 'Like `ActiveModel::Attributes` but less fluffy and more attribute-y.'
+  spec.homepage      = 'https://github.com/joshmn/attributary'
+
+  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.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'attributary'
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/attributary.rb

@@ -0,0 +1,9 @@
+require_relative 'attributary/config'
+require_relative 'attributary/core_ext'
+require_relative 'attributary/type'
+require_relative 'attributary/initializer'
+require_relative 'attributary/dsl'
+require_relative 'attributary/version'
+
+module Attributary
+end

data/lib/attributary/config.rb

@@ -0,0 +1,27 @@
+module Attributary
+  def self.configuration
+    @configuration || Config.new
+  end
+
+  def self.configuration=(val)
+    @configuration = val
+  end
+
+  def self.configure
+    self.configuration ||= Config.new
+    yield(configuration)
+  end
+
+  class Config
+    attr_accessor :dsl_name, :strict_mode
+
+    def initialize
+      @dsl_name = :attribute
+      @strict_mode = false
+    end
+
+    def strict_mode?
+      @strict_mode
+    end
+  end
+end

data/lib/attributary/core_ext.rb

@@ -0,0 +1,15 @@
+class String
+  unless String.respond_to?(:constantize)
+    def constantize
+      Object.const_get(self)
+    end
+  end
+
+  unless String.respond_to?(:safe_constantize)
+    def safe_constantize
+      constantize
+    rescue StandardError
+      nil
+    end
+  end
+end

data/lib/attributary/dsl.rb

@@ -0,0 +1,87 @@
+module Attributary
+  module DSL
+    class ValidationError < StandardError; end
+    class CollectionValidationError < StandardError; end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def _attributary_attribute_set
+        @_attributary_attribute_set ||= {}
+      end
+
+      def _attributary_attributes
+        hash = {}
+        _attributary_attribute_set.keys.each do |k|
+          hash[k] = instance_variable_get(:"@#{k}")
+        end
+        hash
+      end
+
+      define_method(Attributary.configuration.dsl_name) do |name, type, options = {}|
+        options[:type] = type
+        _attributary_attribute_set[name] = options
+        _attributary_reader(name, type, options)
+        _attributary_writer(name, type, options)
+      end
+
+      def _attributary_reader(name, type, options)
+        define_method(name) do
+          instance_variable_get(:"@#{name}") || if options[:default].is_a?(Proc)
+                                                  options[:default].call
+                                                else
+                                                  options[:default]
+                                                end
+        end
+        if type == :boolean
+          define_method("#{name}?") do
+            send(name.to_s)
+          end
+        end
+      end
+
+      def _attributary_writer(name, type, options)
+        define_method("#{name}=") do |value|
+          value = self.class._attributary_cast_to(type, value) unless Attributary.configuration.strict_mode?
+          self.class._attributary_check_collection(value, options[:collection]) if options[:collection].is_a?(Array)
+          self.class._attributary_validate_attribute(value, options[:validates])
+          instance_variable_set(:"@#{name}", value)
+        end
+      end
+
+      def _attributary_check_collection(value, collection)
+        unless collection.include?(value)
+          raise CollectionValidationError, "Value `#{value}' is not in the collection #{collection}."
+        end
+      end
+
+      def _attributary_validate_attribute(value, validator)
+        return true if validator.nil?
+        raise ValidationError, 'Validator failed.' unless validator.call(value)
+      end
+
+      def _attributary_cast_to(type, value)
+        cast_klass = _attributary_cast_class(type)
+        cast_klass.cast_to(value)
+      end
+
+      def _attributary_cast_class(type)
+        cast_klass_name = _attributary_cast_class_name(type)
+        cast_klass = cast_klass_name.safe_constantize
+        if cast_klass.nil?
+          raise NameError, "#{cast_klass_name} is not a valid type."
+        end
+        unless cast_klass.respond_to?(:cast_to)
+          raise NoMethodError, "#{cast_klass} should have a class-method of cast_to"
+        end
+        cast_klass
+      end
+
+      def _attributary_cast_class_name(type)
+        "Attributary::Types::#{type.to_s.split('_').map(&:capitalize).join}Type"
+      end
+    end
+  end
+end

data/lib/attributary/initializer.rb

@@ -0,0 +1,13 @@
+module Attributary
+  module Initializer
+    def initialize(options = {})
+      attributary_initialize(options)
+    end
+
+    def attributary_initialize(options = {})
+      options.each do |k, v|
+        send("#{k}=", v) if attribute_set[k]
+      end
+    end
+  end
+end

data/lib/attributary/type.rb

@@ -0,0 +1,18 @@
+module Attributary
+  module Types
+    class Type
+      def self.cast_to(value)
+        value
+      end
+    end
+  end
+end
+
+require_relative 'types/array_type'
+require_relative 'types/big_decimal_type'
+require_relative 'types/boolean_type'
+require_relative 'types/float_type'
+require_relative 'types/hash_type'
+require_relative 'types/integer_type'
+require_relative 'types/string_type'
+require_relative 'types/symbol_type'

data/lib/attributary/types/array_type.rb

@@ -0,0 +1,9 @@
+module Attributary
+  module Types
+    class ArrayType < Type
+      def self.cast_to(value)
+        value.to_a
+      end
+    end
+  end
+end

data/lib/attributary/types/big_decimal_type.rb

@@ -0,0 +1,9 @@
+module Attributary
+  module Types
+    class BigDecimal < Type
+      def self.cast_to(value)
+        BigDecimal(value.to_s)
+      end
+    end
+  end
+end

data/lib/attributary/types/boolean_type.rb

@@ -0,0 +1,13 @@
+module Attributary
+  module Types
+    class BooleanType < Type
+      def self.cast_to(value)
+        if ['false', 0, '0', false, nil, ''].include?(value)
+          false
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/lib/attributary/types/float_type.rb

@@ -0,0 +1,9 @@
+module Attributary
+  module Types
+    class FloatType < Type
+      def self.cast_to(value)
+        value.to_f
+      end
+    end
+  end
+end

data/lib/attributary/types/hash_type.rb

@@ -0,0 +1,9 @@
+module Attributary
+  module Types
+    class HashType < Type
+      def self.cast_to(value)
+        value.is_a?(Hash) ? value : value.to_h
+      end
+    end
+  end
+end

data/lib/attributary/types/integer_type.rb

@@ -0,0 +1,9 @@
+module Attributary
+  module Types
+    class IntegerType < Type
+      def self.cast_to(value)
+        value.to_i
+      end
+    end
+  end
+end

data/lib/attributary/types/string_type.rb

@@ -0,0 +1,9 @@
+module Attributary
+  module Types
+    class StringType < Type
+      def self.cast_to(value)
+        value.to_s
+      end
+    end
+  end
+end

data/lib/attributary/types/symbol_type.rb

@@ -0,0 +1,9 @@
+module Attributary
+  module Types
+    class SymbolType < Type
+      def self.cast_to(value)
+        value.to_s.to_sym
+      end
+    end
+  end
+end

data/lib/attributary/version.rb

@@ -0,0 +1,3 @@
+module Attributary
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: attributary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Like `ActiveModel::Attributes` but less fluffy and more attribute-y.
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- attributary.gemspec
+- bin/console
+- bin/setup
+- lib/.DS_Store
+- lib/attributary.rb
+- lib/attributary/.DS_Store
+- lib/attributary/config.rb
+- lib/attributary/core_ext.rb
+- lib/attributary/dsl.rb
+- lib/attributary/initializer.rb
+- lib/attributary/type.rb
+- lib/attributary/types/array_type.rb
+- lib/attributary/types/big_decimal_type.rb
+- lib/attributary/types/boolean_type.rb
+- lib/attributary/types/float_type.rb
+- lib/attributary/types/hash_type.rb
+- lib/attributary/types/integer_type.rb
+- lib/attributary/types/string_type.rb
+- lib/attributary/types/symbol_type.rb
+- lib/attributary/version.rb
+homepage: https://github.com/joshmn/attributary
+licenses: []
+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: Like ActiveModel::Attributes but less fluffy and more attribute-y.
+test_files: []