skeema 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Solomon White
+
+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,17 @@
+# Skeema
+
+Three different implementations of parsing ActiveRecord schema.rb files
+
+## Examples:
+
+    # use the regex-based implementation
+    Skeema::Regex.parse('path/to/schema.rb')
+    # => { 'authors' => ['name'], 'posts' => ['author_id', 'title', 'body'] }
+
+    # use the instance_eval-based implementation
+    Skeema::Pretender.parse('path/to/schema.rb')
+    # => { :authors => [:name], :posts => [:author_id, :title, :body] }
+
+    # use the ripper-based implementation
+    Skeema::Ripper.parse('path/to/schema.rb')
+    # => { :authors => [:name], :posts => [:author_id, :title, :body] }

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = %w{--colour --format progress}
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+end
+
+desc "Default: run specs."
+task :default => :spec

data/lib/skeema/pretender.rb

@@ -0,0 +1,50 @@
+module ActiveRecord
+  class Schema
+    def create_table(table_name, options={}, &block)
+      table = Table.new(table_name)
+      yield table if block_given?
+      self.class.add_table(table.name, table.columns)
+    end
+
+    def method_missing(*args)
+      # ignore add_index, etc.
+    end
+
+    def self.define(*args, &block)
+      new.instance_eval(&block)
+    end
+
+    def self.add_table(table_name, columns)
+      @schema ||= {}
+      @schema[table_name] = columns
+    end
+
+    def self.schema
+      @schema || {}
+    end
+  end
+
+  class Table
+    attr_reader :name, :columns
+
+    def initialize(name)
+      @name = name
+      @columns = []
+    end
+
+    def method_missing(data_type, *column_names_and_options)
+      column_names_and_options.pop if column_names_and_options.last.is_a?(Hash)
+      @columns += column_names_and_options
+    end
+  end
+end
+
+module Skeema
+  class Pretender
+    def self.parse(filename)
+      require filename
+
+      ActiveRecord::Schema.schema
+    end
+  end
+end

data/lib/skeema/regex.rb

@@ -0,0 +1,60 @@
+module Skeema
+  class Regex
+    attr_reader :schema
+
+    def initialize
+      @schema = {}
+    end
+
+    def parse(filename)
+      File.open(filename).each_line { |line| process_line(line) }
+      self
+    end
+
+    def process_line(line)
+      in_table? ? process_line_in_table(line) : process_line_outside(line)
+    end
+
+    def process_line_in_table(line)
+      append_columns extract_column_names(line)
+      end_table if line.strip == "end"
+    end
+
+    def process_line_outside(line)
+      table_name = extract_table_name(line)
+      start_table(table_name) if table_name
+    end
+
+    def extract_table_name(line)
+      line.scan(/create_table :(\S+)/).flatten.first
+    end
+
+    def extract_column_names(line)
+      return [] unless line =~ /^\s*t\.(integer|string|text|boolean|date)/
+      without_options = line.split(/(\w+:|:\w+\s*=>)/).first
+      without_options.gsub!(/t\.\w+\s+/, '')
+      without_options.split(/\,\s*/).map{|c| c.gsub(/:/, '').strip }
+    end
+
+    def append_columns(columns)
+      @schema[@table] += columns
+    end
+
+    def start_table(table_name)
+      @table = table_name
+      @schema[@table] = []
+    end
+
+    def end_table
+      @table = nil
+    end
+
+    def in_table?
+      ! @table.nil?
+    end
+
+    def self.parse(filename)
+      new.parse(filename).schema
+    end
+  end
+end

data/lib/skeema/ripper.rb

@@ -0,0 +1,38 @@
+require 'ripper'
+
+module Skeema
+  class Ripper
+    def parse(filename)
+      sexp = ::Ripper.sexp IO.read(filename)
+
+      # yay, magic!
+      schema_commands = sexp[1][0][2][2]
+      @schema = schema_commands.inject({}) do |s, command|
+        if command.length > 1
+          command_name = command[1][1][1]
+
+          if command_name == "create_table"
+            table_name = command[1][2][1][0][1][1][1].to_sym
+            columns    = command[2][2].each.map do |col_command|
+              col_command[4][1][0][1][1][1].to_sym
+            end
+
+            s.merge!(table_name => columns)
+          end
+        end
+
+        s
+      end
+
+      self
+    end
+
+    def schema
+      @schema
+    end
+
+    def self.parse(filename)
+      new.parse(filename).schema
+    end
+  end
+end

data/lib/skeema/version.rb

@@ -0,0 +1,3 @@
+module Skeema
+  VERSION = "0.0.1"
+end

data/skeema.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/skeema/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Solomon White"]
+  gem.email         = ["rubysolo@gmail.com"]
+  gem.description   = %q{Skeema}
+  gem.summary       = %q{Skeema is an experiment in different methods of parsing ActiveRecord schema.rb files}
+  gem.homepage      = "https://github.com/rubysolo/skeema"
+
+  gem.add_development_dependency 'pry-nav'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "skeema"
+  gem.require_paths = ["lib"]
+  gem.version       = Skeema::VERSION
+end

data/spec/fixtures/blog.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define do
+  create_table :authors do |t|
+    t.string :name, :null => false
+  end
+
+  add_index :authors, :name, :unique
+
+  create_table :posts do |t|
+    t.integer :author_id, :null => false
+    t.string :subject
+    t.text :body
+    t.boolean :private, :default => false
+  end
+
+  add_index :posts, :author_id
+end

data/spec/fixtures/empty.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define(:version => 20380119000001) do
+end
+

data/spec/skeema/pretender_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'skeema/pretender'
+
+describe Skeema::Pretender do
+  it 'parses an empty schema' do
+    described_class.parse(fixture_path "empty.rb").should eq({})
+  end
+
+  it 'extracts table info from schema.rb' do
+    schema = described_class.parse(fixture_path "blog.rb")
+    schema.keys.sort.should eq [:authors,  :posts]
+    schema[:posts].should eq [:author_id, :subject, :body, :private]
+  end
+end

data/spec/skeema/regex_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'skeema/regex'
+
+describe Skeema::Regex do
+  it 'extracts table name from create_table statement' do
+    subject.extract_table_name('create_table :authors do |t|').should eq 'authors'
+  end
+
+  it 'returns nil as table name for non-matching statements' do
+    subject.extract_table_name('t.string :subject').should be_nil
+    subject.extract_table_name('add_index :posts, :author_id').should be_nil
+  end
+
+  it 'extracts column names from column definitions' do
+    subject.extract_column_names('t.string :subject').should eq %w( subject )
+    subject.extract_column_names('t.string :subject, :abstract').should eq %w( subject abstract )
+    subject.extract_column_names('t.string :subject, :abstract, :null => false').should eq %w( subject abstract )
+    subject.extract_column_names('t.string :subject, :abstract, null: false').should eq %w( subject abstract )
+  end
+
+  it 'detects start of new table definition' do
+    subject.should_receive(:start_table).with('authors')
+    subject.process_line('create_table :authors do |t|')
+  end
+
+  it 'detects end of table definition' do
+    subject.stub(:in_table?).and_return(true)
+    subject.stub(:append_columns)
+
+    subject.should_receive(:end_table)
+    subject.process_line('  end')
+  end
+
+  it 'parses an empty schema' do
+    described_class.parse("spec/fixtures/empty.rb").should eq({})
+  end
+
+  it 'extracts table info from schema.rb' do
+    schema = described_class.parse("spec/fixtures/blog.rb")
+    schema.keys.sort.should eq %w( authors posts )
+    schema['posts'].should eq %w( author_id subject body private )
+  end
+end

data/spec/skeema/ripper_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'skeema/ripper'
+
+describe Skeema::Ripper do
+  it 'parses an empty schema' do
+    described_class.parse(fixture_path "empty.rb").should eq({})
+  end
+
+  it 'extracts table info from schema.rb' do
+    schema = described_class.parse(fixture_path "blog.rb")
+    schema.keys.sort.should eq [:authors,  :posts]
+    schema[:posts].should eq [:author_id, :subject, :body, :private]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../lib'))
+
+require 'pry-nav'
+require 'rspec'
+require 'rspec/autorun'
+
+def fixture_path(filename)
+  File.join(File.dirname(__FILE__), "fixtures/#{ filename }")
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: skeema
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Solomon White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: &70335173036980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70335173036980
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70335173050880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70335173050880
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70335173050300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70335173050300
+description: Skeema
+email:
+- rubysolo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/skeema/pretender.rb
+- lib/skeema/regex.rb
+- lib/skeema/ripper.rb
+- lib/skeema/version.rb
+- skeema.gemspec
+- spec/fixtures/blog.rb
+- spec/fixtures/empty.rb
+- spec/skeema/pretender_spec.rb
+- spec/skeema/regex_spec.rb
+- spec/skeema/ripper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rubysolo/skeema
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Skeema is an experiment in different methods of parsing ActiveRecord schema.rb
+  files
+test_files:
+- spec/fixtures/blog.rb
+- spec/fixtures/empty.rb
+- spec/skeema/pretender_spec.rb
+- spec/skeema/regex_spec.rb
+- spec/skeema/ripper_spec.rb
+- spec/spec_helper.rb