ars-familiar 0.1.0.alpha2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf7740b326c13d105941cbcd87e85993aa38eb4b
+  data.tar.gz: 69f80e976950ab531dbe8efc2beaef70f2065e9d
+SHA512:
+  metadata.gz: 426c996b6ff9082e06e021329455f3aa5fd3ae994b8919c9c6cb33ab9a6987b981348fb86d0ed1c9003c3e8bafb5a127b813b04e48c762dfbe99fb92e725845a
+  data.tar.gz: 73ef33c480791ccd1cff810da5b0b9ece921f98b41efe73a6215ffd64729bb6924bd3818679e8ae9bb642476f438ccd3e1b928712ddf9f693b2fd294acb5759f

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.local
+/.rvmrc
+
+# rspec failure tracking
+.rspec_status
+
+# Emacs
+*~
+\#*\#
+.\#*

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.14.3

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 cunningfolk
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Lee Vazquez
+
+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,41 @@
+# Ars::Familiar
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ars/familiar`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ars-familiar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ars-familiar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/Michael Lee Vazquez/ars-familiar.
+
+
+## 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/ars-familiar.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ars/familiar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ars-familiar"
+  spec.version       = Ars::Familiar::VERSION
+  spec.authors       = ["Michael Lee Vazquez"]
+  spec.email         = ["magnus.nothus@gmail.com"]
+
+  spec.summary       = %q{ars-familiar-#{Ars::Familiar::VERSION}}
+  spec.description   = %q{Ruby Object Metadata Reflector}
+  spec.homepage      = "http://github.com/cunningfolk/ars-familiar"
+  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"]
+
+  %w[].each do |lib_name|
+    if Ars::Familiar::VERSION =~ /[a-zA-Z]+/
+      spec.add_runtime_dependency "ars-#{lib_name}", "= #{Ars::Familiar::VERSION}"
+    else
+      spec.add_runtime_dependency "ars-#{lib_name}", "~> #{Ars::Familiar::VERSION.sub(/^((?:\d+\.){2}).*$/, '\1.0')}"
+    end
+  end
+
+  spec.add_runtime_dependency 'activesupport'
+  
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'rake'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ars/familiar"
+
+# 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/ars/familiar/base.rb

@@ -0,0 +1,58 @@
+module Ars
+  module Familiar
+    class Base
+
+      def scribe(dump)
+        if dump
+          %i{ attributes_to_define relationships_to_define primary_key id }.each do |attr|
+            const_set "@#{attr}", dump[attr]
+          end
+        end
+        {
+          attributes_to_define: @attributes_to_define,
+          relationships_to_define: @relationships_to_define,
+          primary_key: @primary_key,
+          id: @id
+        }
+      end
+
+      def id
+        @id || id!
+      end
+
+      def attributes_to_define
+        @attributes_to_define || attributes_to_define!
+      end
+
+      def relationships_to_define(**opts)
+        @relationships_to_define || relationships_to_define!(**opts)
+      end
+
+      def extract_options(**opts)
+        class_map = map_classes(opts)
+
+        only = opts.fetch(:only, :pass).entries.each_with_object(class_map) {|val, hash|  hash.store(*val) }.keys
+        class_map
+
+        filter = proc do |relation|
+          name = relation[:name]
+
+          only == :pass || only.include?(name)
+        end
+
+        [filter, class_map]
+      end
+
+      def map_classes(**opts)
+        class_base  = opts.fetch(:class_base, nil)
+        class_name  = opts.fetch(:class_name, false)
+        class_names = opts.fetch(:class_names, {})
+
+        Hash.new {|hash, key| hash[key] = [class_base, key].constantize }.
+          tap {|this| class_name && this.default = class_name}.
+          merge(class_names)
+      end
+
+    end
+  end
+end

data/lib/ars/familiar/constantizable_array.rb

@@ -0,0 +1,7 @@
+class ConstantizableArray < Array
+  ConstantizableArray::EMPTY_PARAM = "EMPTY_PARM".freeze
+  def constantize(wedge = EMPTY_PARAM)
+    wedge == EMPTY_PARAM && wedge = '::'
+    self.compact.join(wedge).constantize
+  end
+end

data/lib/ars/familiar/mongoid.rb

@@ -0,0 +1,78 @@
+module Ars
+  module Familiar
+    class Mongoid < Base
+
+      attr_reader :model, :model_name, :class_map
+
+      def [](*args)
+        ConstantizableArray[args]
+      end
+
+      def initialize(model)
+        @model_name = model
+        if Object.const_defined? model.to_s, true
+          @model = model.constantize
+        end
+      end
+
+      def primary_key!
+        @primary_key =
+          case
+          when model.respond_to?(:primary_key)
+            model.primary_key
+          when model.respond_to?(:guid), model.public_method_defined?(:guid)
+            :guid
+          end
+      end
+
+      def primary_key
+        @primary_key || primary_key!
+      end
+
+      def primary_key?
+        !!primary_key
+      end
+
+      def id!
+        @id = primary_key? ? primary_key : :id
+      end
+
+      def attributes_to_define!
+        @attributes_to_define = standard_fields.keys.map(&:to_sym)
+      end
+
+      def standard_fields
+        model.fields.select{|name, field| field.class.name == 'Mongoid::Fields::Standard'}.
+          tap{|fields| fields[id] = fields.delete("_id") }
+      end
+
+      def relationships_to_define!(**opts)
+        filter, class_map = extract_options(opts)
+
+        @relationships_to_define =
+          model.relations.values.select(&filter).flat_map { |relation|
+          name = relation.fetch(:name)
+
+          [*relation_switch(relation.fetch(:relation))].
+            map{|rel| [rel, name, class_name: class_map[name]] }.
+            compact
+        }.compact
+      end
+
+      def relation_switch(name)
+        case name.name
+        when 'Mongoid::Relations::Embedded::Many', 'Mongoid::Relations::Referenced::Many'
+          :has_many
+        when 'Mongoid::Relations::Embedded::One',  'Mongoid::Relations::Referenced::One'
+          :has_one
+        when 'Mongoid::Relations::Referenced::ManyToMany'
+          return :has_many, :belongs_to
+        else
+          raise StandardError, "Unknown Relationship: #{name}"
+        end
+      end
+
+    end
+  end
+end
+

data/lib/ars/familiar/scribe.rb

@@ -0,0 +1,86 @@
+require 'active_support/inflector'
+require 'fileutils'
+
+module Ars
+  module Familiar
+    module Scribe
+
+      class Entry < String
+        def initialize(string)
+          super(string.to_s)
+        end
+
+        def to_filename
+          string = self.dup
+          string.gsub!(/::/, '/')
+          string.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          string.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+          string.tr!("-", "_")
+          string.downcase!
+          string << '.dump'
+          string
+        end
+
+        def to_class
+          self.respond_to?(:name) ? self : self.constantize
+        end
+      end
+
+      module Scribable
+        def scribable(bool = nil)
+          !bool.nil? && @scribable = bool
+        end
+        def scribable?
+          @scribable
+        end
+        def self.extended(subclass)
+          subclass.scribable true
+          Scribe.register subclass
+        end
+      end
+
+      @register = []
+
+      def self.register(class_name = nil)
+        return @register # bypass
+        return @register unless class_name
+        return @register if @register.member?(class_name)
+        return @register unless class_name.builder.respond_to? :scribe
+        @register << Entry.new(class_name)
+        @register
+      end
+
+      def self.commit
+        register.each do |entry|
+          dump = Marshal.dump(entry.to_class.scribe)
+
+          filename = File.join(Ars::Medium.configuration.root, 'lib/portable_models', model.to_filename)
+          dirname = File.dirname filename
+          FileUtils.mkdir_p dirname
+          File.open(filename, 'w') do |file|
+            file << dump
+          end
+
+        end
+      end
+
+      def self.read_for(model)
+        model = Entry.new(model.class.name)
+
+        filename = File.join(Ars::Medium.configuration.root, 'lib/portable_models', model.to_filename)
+        dirname = File.dirname filename
+        FileUtils.mkdir_p dirname
+        if File.exist? filename
+          File.open(filename, 'r') do |file|
+            model.scribe Marshal.load(file)
+          end
+        end
+      end
+
+      def self.included(subclass)
+        subclass.extend Scribable
+      end
+
+    end
+  end
+end

data/lib/ars/familiar/version.rb

@@ -0,0 +1,5 @@
+module Ars
+  module Familiar
+    VERSION = "0.1.0.alpha2"
+  end
+end

data/lib/ars/familiar.rb

@@ -0,0 +1,39 @@
+require "ars/familiar/version"
+require 'active_support/inflector'
+
+module Ars
+  module Familiar
+    autoload :Mongoid, 'ars/familiar/mongoid'
+    autoload :Base,    'ars/familiar/base'
+    autoload :Scribe,  'ars/familiar/scribe'
+
+    module DSL
+      attr_reader :builder
+
+      def shadow(model)
+        consume = model.dup
+        model = Familiar::Mongoid.new(model)
+        consumed = consume.constantize rescue false
+        unless consumed
+          Scribe.read_for model
+        end
+        @builder = model
+      end
+
+      def realize_attributes!
+        primary_key builder.primary_key if builder.primary_key?
+        attributes builder.attributes_to_define
+      end
+
+      def realize_relationships!(**opts)
+        builder.relationships_to_define(opts).each do |relationship|
+          self.send(*relationship)
+        end
+      end
+    end
+
+    def self.included(subclass)
+      subclass.extend DSL
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: ars-familiar
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha2
+platform: ruby
+authors:
+- Michael Lee Vazquez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Ruby Object Metadata Reflector
+email:
+- magnus.nothus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- ars-familiar.gemspec
+- bin/console
+- bin/setup
+- lib/ars/familiar.rb
+- lib/ars/familiar/base.rb
+- lib/ars/familiar/constantizable_array.rb
+- lib/ars/familiar/mongoid.rb
+- lib/ars/familiar/scribe.rb
+- lib/ars/familiar/version.rb
+homepage: http://github.com/cunningfolk/ars-familiar
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ars-familiar-#{Ars::Familiar::VERSION}
+test_files: []