schema_reader 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2138524a728c81f8778e9afa8d0758f558bd77da
+  data.tar.gz: d3fee34b1fe3a7f0bb2896cc58b19b9092358d8f
+SHA512:
+  metadata.gz: a441d6a528fd148912bb10a186d39526eab221eda00d34d8f2f9dd56d48708f5a04a989c542ae5a27d02d174492afdab6a4a81874d35a46c19ca19bbc55c5078
+  data.tar.gz: 5cf253b6f588644d3fcf4982627a11561a7e16dc1d7fc1129245d9af0c4556bfb0cb043afa85a46e8c276f359857a744768298ee5944d18d0154af3a7a4cddb3

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dustin Zeisler
+
+MIT License
+
+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,79 @@
+# Schema Reader
+
+Reads Rails Database schema.rb and creates a class from selected table with getters and setters.
+
+This was created for unit testing Rails ActiveRecord. Instead of creating a mock that can
+become out of date with real objects schema reader creates mocks form the true definition.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'schema_reader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schema_reader
+
+## Usage
+
+    # db/schema.rb
+
+    ActiveRecord::Schema.define(version: 20131226214224) do
+
+      create_table "users", force: true do |t|
+        t.string   "name"
+        t.integer  "age"
+        t.string   "email"
+      end
+
+      create_table "comments", force: true do |t|
+          t.text    "comment"
+          t.integer  "user_id"
+          t.datetime "created_at"
+          t.datetime "updated_at"
+        end
+
+    end
+
+    # /spec/*
+    class User
+      include SchemaReader
+      attr_schema table: 'users', file:  File.new('db/schema.rb', 'r')
+    end
+
+    user = User.new(name: 'Fred', age: 37, email: "fred@example.com")
+
+    user.name
+        => "Fred"
+    user.name = "Jane"
+    user.name
+        => "Jane"
+
+    user.update(age: 23)
+    user.age
+        => 23
+
+    class Comment
+      include SchemaReader
+      attr_schema table: 'comments', file:  File.new('db/schema.rb', 'r')
+    end
+
+    # Based off field names ending with _id it will create an association
+
+    comment = Comment.new(user: user)
+    comment.user.name
+         => "Jane"
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/schema_reader.rb

@@ -0,0 +1,96 @@
+require "schema_reader/version"
+
+module SchemaReader
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def initialize(options = {})
+    update(options)
+  end
+
+  def update(options = {})
+    options.each do |attribute, value|
+      send("#{attribute}=", value)
+    end
+  end
+  alias_method :update_attributes, :update
+
+  module ClassMethods
+
+    def attr_schema(options = {})
+      table = options.fetch(:table)
+      file = options.fetch(:file)
+      self.send(:attr_accessor, *read_schema(table, file))
+    end
+
+    def read_schema(table_selected, path)
+      tables = parse_for_tables(path)
+      table = find_table(tables, table_selected)
+      field_names = get_table_field_name(table)
+      add_associations(field_names)
+    end
+
+    private
+
+    def add_associations(field_names)
+      association_fields = field_names.select {|field| field =~ /_id/}
+      field_names += association_fields.map {|field| field.to_s.delete('_id').to_sym}
+      field_names
+    end
+
+    def parse_for_tables(path)
+      File.read(path).split(/^\s*create_/)[1..-1].map {|table_data| Table.parse table_data }
+    end
+
+    def find_table(tables, table_selected)
+      table = tables.select do |table|
+        table.name == table_selected
+      end
+      raise "Table Name not Found!" if table.first.nil?
+      table.first
+    end
+
+    def get_table_field_name(table)
+      table.attributes.map do |attribute|
+        attribute.name.to_sym
+      end
+    end
+
+  end
+
+  class Attribute
+
+    attr_reader :name, :type
+
+    def initialize(type, name)
+      @name, @type = name, type
+    end
+
+    def self.parse(attribute)
+      match = attribute.match(/t\.(\w+)\s+"(\w+)"/)
+      if match
+        Attribute.new(*match.captures)
+      end
+    end
+
+  end
+
+  class Table
+
+    attr_reader :attributes, :name
+
+    def initialize(name, attributes)
+      @name, @attributes = name, attributes
+    end
+
+    def self.parse(table_data)
+      return unless name = table_data[/table "(.+)"/]
+      name = $1
+      atts = table_data.lines.to_a.select {|line| line =~ /t\.\w+/ }.map {|att| Attribute.parse att }
+      Table.new(name, atts)
+    end
+
+  end
+
+end

data/lib/schema_reader/version.rb

@@ -0,0 +1,3 @@
+module SchemaReader
+  VERSION = "0.0.3"
+end

data/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(version: 20131226214224) do
+
+  create_table "users", force: true do |t|
+    t.string   "name"
+    t.integer  "age"
+    t.string   "email"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "comments", force: true do |t|
+    t.text    "comment"
+    t.integer  "user_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/schema_reader.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schema_reader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schema_reader"
+  spec.version       = SchemaReader::VERSION
+  spec.authors       = ["Dustin Zeisler"]
+  spec.email         = ["dustin@zive.me"]
+  spec.description   = %q{Reads Rails Database schema and creates a class from selected table with getters and setters.}
+  spec.summary       = %q{This was created for unit testing Rails ActiveRecord.
+                        Instead of creating a mock that can become out of date with real objects schema reader creates mocks form the true definition.}
+  spec.homepage      = "https://github.com/zeisler/schema_reader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~>10.1"
+  spec.add_development_dependency "rspec", "~>2.14"
+  spec.add_development_dependency "debase", "~>0.0"
+  spec.add_development_dependency "ruby-debug-ide", "~>0.4"
+
+end

data/spec/lib/schema_reader_spec.rb

@@ -0,0 +1,79 @@
+require 'rspec'
+require_relative '../../lib/schema_reader'
+
+describe SchemaReader do
+
+  context 'read_schema' do
+
+    before do
+      class SchemaHash
+        include SchemaReader
+        attr_accessor *read_schema('users', File.new('schema.rb', 'r'))
+      end
+    end
+
+    it 'returns attributes from schema file' do
+      expect(SchemaHash.read_schema('users', File.new('schema.rb', 'r'))).to eq [:name, :age, :email, :created_at, :updated_at]
+    end
+
+    it 'will raise an exception if table does not exist' do
+      -> {SchemaHash.read_schema('persons', File.new('schema.rb', 'r'))}.should raise_error('Table Name not Found!')
+    end
+
+  end
+
+  describe 'attr_schema' do
+
+    before do
+      class User
+        include SchemaReader
+        attr_schema table: 'users',
+                    file:  File.new('schema.rb', 'r')
+      end
+    end
+
+    let(:user) {User.new}
+    let(:attributes) { Hash.new(name: 'Fred', age: 37, email: "fred@example.com") }
+
+    it 'will set getters and setters for schema attributes on object' do
+      attributes.each_pair do |attribute, value|
+        user.send("#{attribute}=", value)
+        expect(user.send(attribute)).to eq value
+      end
+    end
+
+    it 'will not respond to non-schema attributes' do
+      expect(user.respond_to? :birth_date).to eq(false)
+    end
+
+    it 'update' do
+      user.update(name: "Jane")
+      expect(user.name).to eq('Jane')
+    end
+
+  end
+
+  describe 'associations' do
+
+    before do
+      class Comment
+        include SchemaReader
+        attr_schema table: 'comments',
+                    file:  File.new('schema.rb', 'r')
+      end
+
+      class User
+        include SchemaReader
+        attr_schema table: 'users',
+                    file:  File.new('schema.rb', 'r')
+      end
+    end
+    let(:comment) {Comment.new(user: User.new)}
+
+    it 'will create associations of attributes ending with _id' do
+      expect(comment.user.class).to eq User
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: schema_reader
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Dustin Zeisler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Reads Rails Database schema and creates a class from selected table with
+  getters and setters.
+email:
+- dustin@zive.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/schema_reader.rb
+- lib/schema_reader/version.rb
+- schema.rb
+- schema_reader.gemspec
+- spec/lib/schema_reader_spec.rb
+homepage: https://github.com/zeisler/schema_reader
+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.0
+signing_key: 
+specification_version: 4
+summary: This was created for unit testing Rails ActiveRecord. Instead of creating
+  a mock that can become out of date with real objects schema reader creates mocks
+  form the true definition.
+test_files:
+- spec/lib/schema_reader_spec.rb