magic_models 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 223608e9416366b9e8013ff21a3f56040fa477c0
+  data.tar.gz: 799ada84ee5ff4bc85208bce614dbafc68af3c78
+SHA512:
+  metadata.gz: 2943748c0e52a71e6a45ab3ae8fd580f20f437b89da1a374dc7e63410b158680a484d1730f88dfc195804a8639372a08119de7f004311c0dac30cc36767304e5
+  data.tar.gz: 2771b0e4b8d2bd5eb80bb64e1dfd401223a14296e75beac771b1aa0f4338d68e9481eab5f762d9e85548b3c642ea26c80fd25bf77b55f31bf0319c023ea51b95

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ray Zane
+
+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,94 @@
+# MagicModels
+
+Have an existing database? MagicModels can generate models on the fly using your existing database connection.
+
+If you have a table called `people`, just call `MagicModels.define`. Now, you have a model called `Person`. Boom!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'magic_models'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install magic_models
+
+## Usage
+
+MagicModels has two main functions:
+
++ **dump**: Generate files for your Active Record models.
++ **define**: Declare models at runtime without creating any files.
+
+First, you'll need to point your app at an existing database. To do that, just edit your `config/database.yml`.
+
+To define your models at runtime, just put this line in an initializer:
+
+```ruby
+MagicModels.define
+```
+
+If you want to dump your models to files, run this shell command:
+
+```shell
+$ rails runner 'MagicModels.dump'
+```
+
+## Configuration
+
+MagicModels also offers some configuration settings. `MagicModels.define` and `MagicModels.dump` accept a block:
+
+```ruby
+MagicModels.define do |config|
+end
+
+MagicModels.dump do |config|
+end
+```
+
+#### Shared settings
+
+```ruby
+# Ignore certian tables (default: schema_migrations, ar_internal_metadata)
+config.exclude 'some_table', 'some_other_table'
+
+# Change the connection (default: ActiveRecord::Base.connection)
+config.connection = SomeOtherModel.connection
+
+# Declare a different class to inherit from (default: ActiveRecord::Base)
+config.base_class = 'SomeOtherAncestor'
+```
+
+#### Dump-specific settings
+
+```ruby
+# Change the directory where the model files will be created (default: app/models)
+config.destination = '/path/to/your/models/dir'
+```
+
+#### Define-specific settings
+
+```ruby
+# Change the namespace to create the models under. For example, if you had a table
+# named 'foos', this configuration would create `SomeModule::Foo` instead of `Foo`.
+config.namespace = SomeModule
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rzane/magic_models.
+
+## Props
+
++ [Dr. Nic's Magic Models](https://github.com/drnic/dr-nic-magic-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,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'magic_models'
+require 'pry'
+
+require_relative '../spec/schema'
+
+Pry.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/magic_models.rb

@@ -0,0 +1,18 @@
+require 'magic_models/version'
+require 'magic_models/schema'
+
+module MagicModels
+  class << self
+    def define
+      schema = Schema::Define.new
+      yield schema if block_given?
+      schema.models.map(&:define)
+    end
+
+    def dump(&block)
+      schema = Schema::Dump.new
+      yield schema if block_given?
+      schema.models.map(&:write)
+    end
+  end
+end

data/lib/magic_models/associations.rb

@@ -0,0 +1,25 @@
+module MagicModels
+  module Associations
+    class BelongsTo
+      attr_reader :foreign_key, :primary_key
+
+      def initialize(foreign_key)
+        @table_name = foreign_key.to_table
+        @primary_key = foreign_key.options[:primary_key]
+        @foreign_key = foreign_key.options[:column]
+      end
+
+      def name
+        @foreign_key.sub(/_id$/, '').singularize
+      end
+
+      def macro
+        'belongs_to'
+      end
+
+      def class_name
+        @table_name.singularize.camelize
+      end
+    end
+  end
+end

data/lib/magic_models/model.rb

@@ -0,0 +1,58 @@
+require 'erb'
+require 'magic_models/associations'
+
+module MagicModels
+  class Model
+    attr_reader :schema, :name
+
+    delegate :base_class, to: :schema
+    delegate :constantize, to: :model_name
+
+    def initialize(schema, name)
+      @schema = schema
+      @name   = name
+    end
+
+    def filename
+      File.join(schema.destination, "#{model_name.underscore}.rb")
+    end
+
+    def render
+      ERB.new(File.read(template)).result(binding)
+    end
+
+    def write
+      File.open(filename, 'w') { |f| f.write render }
+      filename
+    end
+
+    def define
+      schema.evaluate(render)
+      constantize
+    end
+
+    def primary_key
+      @primary_key ||= schema.primary_key(name)
+    end
+
+    def belongs_to
+      schema.foreign_keys(name).map do |fk|
+        Associations::BelongsTo.new(fk)
+      end
+    end
+
+    # Currently, we only support belongs_to associations. I don't think
+    # there is a way to differentiate a has_one from a has_many.
+    alias associations belongs_to
+
+    def model_name
+      name.singularize.camelize
+    end
+
+    private
+
+    def template
+      File.expand_path('../../templates/model.erb', __FILE__)
+    end
+  end
+end

data/lib/magic_models/schema.rb

@@ -0,0 +1,52 @@
+require 'active_record'
+require 'magic_models/model'
+
+module MagicModels
+  module Schema
+    class Base
+      attr_accessor :base_class, :connection
+      delegate :primary_key, :foreign_keys, to: :connection
+
+      def initialize
+        @base_class = 'ActiveRecord::Base'
+        @connection = ActiveRecord::Base.connection
+        @exclude = ['schema_migrations', 'ar_internal_metadata']
+      end
+
+      def exclude(*tables)
+        @exclude += tables.flatten
+      end
+
+      def data_sources
+        connection.data_sources - @exclude
+      end
+
+      def models
+        data_sources.map do |name|
+          Model.new(self, name)
+        end
+      end
+    end
+
+    class Define < Base
+      attr_accessor :namespace
+
+      def evaluate(*args, &block)
+        if namespace
+          namespace.module_eval(*args, &block)
+        else
+          TOPLEVEL_BINDING.eval(*args, &block)
+        end
+      end
+    end
+
+    class Dump < Base
+      attr_accessor :destination
+
+      def initialize
+        super
+        @destination = File.join(Dir.pwd, 'app', 'models')
+      end
+    end
+  end
+end

data/lib/magic_models/version.rb

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

data/lib/templates/model.erb

@@ -0,0 +1,10 @@
+class <%= model_name %> < <%= base_class %>
+  self.table_name = <%= name.inspect %>
+  self.primary_key = :<%= primary_key %>
+<% associations.each do |association| %>
+  <%= association.macro %> :<%= association.name %>,
+    class_name: <%= association.class_name.inspect %>,
+    foreign_key: :<%= association.foreign_key %>,
+    primary_key: :<%= association.primary_key %>
+<% end %>
+end

data/magic_models.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magic_models/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magic_models"
+  spec.version       = MagicModels::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["ray@promptworks.com"]
+
+  spec.summary       = %q{Generate models at runtime from a database connection!}
+  spec.homepage      = "https://github.com/rzane/magic_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 'activerecord'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: magic_models
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 
+email:
+- ray@promptworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/magic_models.rb
+- lib/magic_models/associations.rb
+- lib/magic_models/model.rb
+- lib/magic_models/schema.rb
+- lib/magic_models/version.rb
+- lib/templates/model.erb
+- magic_models.gemspec
+homepage: https://github.com/rzane/magic_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.6.10
+signing_key: 
+specification_version: 4
+summary: Generate models at runtime from a database connection!
+test_files: []