static_models 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ea954799a4013aebd0fd97a706fb65cdd3a04f5
+  data.tar.gz: 991966ce298336a266fa9b8859d41fa4f2fd2aca
+SHA512:
+  metadata.gz: 968c9408edeed32e1f509eb0b117193f9f3235c52f7785c9889d7562f6d0ae14ca520d24df0a181f10d7cc78e948b951da503658defdbfbe86ca8d9894d448a0
+  data.tar.gz: 482f3bfedef5c81ac5da2a573cadbc3c16f5b55d2361fe88a660f12d08125ef73dd6fc892376a92a82226b8905d8e432adcb3305db77a52f2dc788c764530d4e

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 nubis
+
+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,116 @@
+# StaticModels
+
+DRY your accesory "key - value" classes. Use them as associations on a parent model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'static_models'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install static_models
+
+## Usage
+
+```ruby
+    # We're modelling Dog's, each of them has a Breed.
+    # We support a static set of Breeds.
+
+    class Breed
+      # Enhance Breed to be a StaticModel
+      include StaticModels::Model 
+
+      # Actually define the breeds we support using a Hash
+      # Keys are the 'id' attribute of each model. Must be Integers.
+      # Values are the 'code' attribute. Must be Symbols, and unique.
+      # If you want your model to have extra attributes, make te value
+      # be an Array of 2 elements: [Symbol, Hash].
+      static_models(
+        1 => :collie,
+        2 => :foxhound,
+        6 => [:corgi, height: 'short'],
+        7 => [:doberman, height: 'tall']
+      )
+    end
+
+    # You can find your Breed.
+    Breed.find(6).tap do |b|
+      # You also get class methods for accessing each singleton instance.
+      b == Breed.corgi 
+
+      b.code == :corgi
+      b.height == 'short'
+    end
+
+    # Definitions can be sparse, no need to set a value for all attributes.
+    Breed.collie.height.should be_nil
+
+    # All just returns the ordered collection.
+    Breed.all.should == [
+      Breed.collie,
+      Breed.foxhound,
+      Breed.corgi,
+      Breed.doberman
+    ]
+
+    # The low level 'values' dictionary is public.
+    Breed.values.should == {
+      1 => Breed.collie,
+      2 => Breed.foxhound,
+      6 => Breed.corgi,
+      7 => Breed.doberman
+    }
+
+    # You can use your StaticModels similar to an association.
+    # Setting a Breed will update a breed_id attribute.
+    class Dog
+      attr_accessor :breed_id
+
+      include StaticModels::BelongsTo
+      belongs_to_static_model :breed
+    end
+
+    Dog.new.tap do |d|
+      # Setting a Breed will update the underlying breed_id column.
+      d.breed_id == nil
+      d.breed = Breed.corgi
+      d.breed_id == 6
+      
+      # Also, setting the breed_id column will update the Breed.
+      d.breed_id = 7
+      d.breed.should == Breed.doberman
+    end
+
+    # Set your model manually if it can't be inferred from the attribute name
+
+    class WeirdDoggie
+      attr_accessor :dog_kind_id
+
+      include StaticModels::BelongsTo
+      belongs_to_static_model :dog_kind, Breed
+    end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/static_models.
+
+
+## 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 "static_models"
+
+# 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,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/static_models/version.rb

@@ -0,0 +1,3 @@
+module StaticModels
+  VERSION = "0.1.0"
+end

data/lib/static_models.rb

@@ -0,0 +1,96 @@
+require "static_models/version"
+require "active_support"
+require "active_support/inflector"
+
+module StaticModels
+  module Model
+    extend ActiveSupport::Concern
+
+    included do |i|
+      cattr_accessor :values
+
+      def initialize(id, code, *args)
+        self.id = id
+        self.code = code
+        unless args.empty?
+          args.first.each{|name,value| send("#{name}=", value) }
+        end
+      end
+
+      def to_s
+        code.to_s
+      end
+
+      def to_i
+        id
+      end
+
+      def name
+        code
+      end
+    end
+
+    class_methods do
+      def static_models(new_values)
+        attr_accessor :id, :code
+
+        self.values = {}
+        new_values.each do |k,v|
+          unless k.is_a?(Integer)
+            raise TypeError.new("Expected Integer for keys, found #{k.class}")
+          end
+
+          if v.is_a?(Array)
+            unless v.size == 2 && v.first.is_a?(Symbol) && v.last.is_a?(Hash)
+              raise TypeError.new("Expected [Symbol, Hash] found #{v.class}") 
+            end
+            attr_accessor *v.last.keys
+          else
+            unless v.is_a?(Symbol)
+              raise TypeError.new("Expected Symbol, found #{v.class}")
+            end
+          end
+          item = new(k, *v)
+          values[k] = item
+
+          raise DuplicateCodes.new if singleton_methods.include?(item.code)
+          define_singleton_method(item.code){ item }
+        end
+      end
+
+      def find(id)
+        values[id.to_i]
+      end
+
+      def all
+        values.values
+      end
+    end
+  end
+
+  # When included, it adds a class method that works similar to rails
+  # 'belongs_to', but instead of fetching an association it gets a static model.
+  module BelongsTo
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def belongs_to_static_model(attr_name, cls=nil)
+        cls ||= attr_name.to_s.humanize.constantize
+
+        define_method(attr_name) do
+          cls.find(send("#{attr_name}_id"))
+        end
+
+        define_method("#{attr_name}=") do |value|
+          unless value.nil? || value.is_a?(cls)
+            raise TypeError.new("Expected #{cls} got #{value.class}")
+          end
+          send("#{attr_name}_id=", value && value.id)
+        end
+      end
+    end
+  end
+
+  class TypeError < StandardError; end
+  class DuplicateCodes < StandardError; end
+end

data/static_models.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'static_models/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "static_models"
+  spec.version       = StaticModels::VERSION
+  spec.authors       = ["nubis"]
+  spec.email         = ["yo@nubis.im"]
+
+  spec.summary       = %q{DRY your key-value classes. Use them as associations}
+  spec.description   = %q{
+    Replace your key/value classes with this.
+    Define classes with several 'singleton' instances.
+  }
+  spec.homepage      = "https://github.com/bitex-la/static_models"
+  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_dependency "activesupport", '~> 4.2', '>= 4.2.0'
+
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: static_models
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nubis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "\n    Replace your key/value classes with this.\n    Define classes
+  with several 'singleton' instances.\n  "
+email:
+- yo@nubis.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/static_models.rb
+- lib/static_models/version.rb
+- static_models.gemspec
+homepage: https://github.com/bitex-la/static_models
+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.5.1
+signing_key: 
+specification_version: 4
+summary: DRY your key-value classes. Use them as associations
+test_files: []