columns 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fb05fd5b271d2da52b43da4de35438a74802cc0
+  data.tar.gz: c2a54c11f138608d8905798d32f91b75e360cc20
+SHA512:
+  metadata.gz: bbf3877d98afc1460945b9641b0153c582763522b87668fc5459dbb9c2d485e608abe1d75657d2c1f45234675b03246ad28e6e7ec293b33574abd69adec95b0a
+  data.tar.gz: 830ff6fafe2c9961be383205715ee7989dde535d117d8c049995ed2d9ff755c3c04e467594a197301cd3fff22db58cfc34ac98563ce719bb79591ea6f3fd0289

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
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order=random

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 lkdjiin
+
+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,39 @@
+# Columns
+
+Annotates activerecord models using `db/schema.rb`.
+
+This is an alternative to the annotate gem for non rails apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'columns'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install columns
+
+## Usage
+
+    $ cd your_project
+
+Once you have generate a `db/schema.rb`, just type
+
+    $ columns
+
+to annotate your models.
+
+Note that models must to reside in `app/models`.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/columns/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/columns

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'columns'
+
+# find all tables in the schema
+schema_file = File.expand_path('./db/schema.rb')
+
+unless File.exists?(schema_file)
+  puts "COLUMNS ERROR : #{schema_file} doesn't exist!"
+  exit 1
+end
+table = Columns::Table.new(File.read(schema_file))
+
+# create RawData for each tables
+raw_data_objects = []
+table.names.each do |name|
+  raw_data_objects << Columns::RawData.new(name, table.content_for(name))
+end
+
+# create ModelData from each RawData
+model_data_objects = raw_data_objects.map do |o|
+  Columns::ModelData.new(o)
+end
+
+# clean all models using ModelCleaner
+# write all models using ModelData
+writer = Columns::ModelWriter.new
+model_data_objects.each do |o|
+  path = File.expand_path('./app/models/' + o.name + '.rb')
+  Columns::ModelCleaner.clean(path)
+  writer.add_info(o)
+end
+
+

data/columns.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'columns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "columns"
+  spec.version       = Columns::VERSION
+  spec.authors       = ["lkdjiin"]
+  spec.email         = ["xavier.nayrac@gmail.com"]
+  spec.summary       = %q{Annotates activerecord models using `db/schema.rb`.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ['>=2.0.0', '<2.2.0']
+
+  spec.add_development_dependency "bundler", "~> 1.6.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~>3.0.0'
+  spec.add_development_dependency "reek", '~>1.3.7'
+  spec.add_development_dependency "coco"
+
+  spec.requirements << 'sed'
+end

data/lib/columns/extended_content.rb

@@ -0,0 +1,15 @@
+module Columns
+
+  # Extends a content (column names and types) with some meta data.
+  class ExtendedContent
+
+    # Public: Get the extended content.
+    #
+    # content - The String content (from a ModelData object).
+    #
+    # Returns the String extended content.
+    def self.from(content)
+      "# == Schema Information\n#\n#{content}"
+    end
+  end
+end

data/lib/columns/model_cleaner.rb

@@ -0,0 +1,17 @@
+module Columns
+
+  # Public: This class is responsible of removing a possible schema info
+  # from a ruby model file. Note that it isn't any attempt to actually
+  # check if we really deals with a model.
+  class ModelCleaner
+
+    # Public: Removes schema info.
+    #
+    # file_path - An absolute String file name.
+    #
+    # Returns nothing.
+    def self.clean(file_path)
+      %x( sed -i -e '/# == Schema Info/,$d' #{file_path}  > /dev/null 2>&1 )
+    end
+  end
+end

data/lib/columns/model_data.rb

@@ -0,0 +1,39 @@
+module Columns
+
+  # Public: Stores data about a model.
+  #
+  # Model name
+  # ----------
+  # Usually a table is named with a plural, like 'users'. The
+  # corresponding model name is in singular, like 'user'.
+  #
+  # Model content
+  # -------------
+  # We want a «ready to paste» content.
+  #
+  # So, for example, if the raw content is:
+  #
+  #     integer "foo"
+  #
+  # what we want is something like this:
+  #
+  #     #  integer "foo"
+  class ModelData
+
+    # Public: Get the model's name. For a model `app/models/user.rb`,
+    # the model's name will be `user`.
+    attr_reader :name
+
+    attr_reader :content
+
+    def initialize(raw_data)
+      # Ok, this is really idiot, I know, I know. Must use inflectors in
+      # the future.
+      @name = raw_data.name[0...-1]
+
+      contents = raw_data.content.split("\n")
+      contents.map! {|line| "#  #{line.gsub(/^\s*t\./, '')}\n" }
+      @content = contents.join
+    end
+  end
+end

data/lib/columns/model_writer.rb

@@ -0,0 +1,30 @@
+module Columns
+
+  # Public: Add schema info to the end of a ruby model.
+  class ModelWriter
+
+    def initialize(path: './app/models/')
+      @path = path
+    end
+
+    def add_info(model_data)
+      @model_data = model_data
+      ensure_file_end_with_empty_line
+      if File.exists?(model_path)
+        File.open(model_path, 'a') do |file|
+          file.puts(ExtendedContent.from(@model_data.content))
+        end
+      end
+    end
+
+    private
+
+    def model_path
+      File.expand_path(File.join(@path, @model_data.name) + '.rb')
+    end
+
+    def ensure_file_end_with_empty_line
+      %x( sed -i -e '$a\\' #{model_path} > /dev/null 2>&1 )
+    end
+  end
+end

data/lib/columns/raw_data.rb

@@ -0,0 +1,13 @@
+module Columns
+
+  # Public: A simple object to store raw data about a table.
+  class RawData
+    attr_reader :name, :content
+
+    def initialize(name, content)
+      @name = name
+      @content = content
+    end
+
+  end
+end

data/lib/columns/regex.rb

@@ -0,0 +1,17 @@
+module Columns
+
+  # Public: Utility methods related to regular expressions.
+  module Regex
+
+    # Public: Find a table name if it exists.
+    #
+    # string - The String to scan for a table name.
+    #
+    # Returns a String table name or nil.
+    def self.table_name(string)
+      string.match(/create_table\s*"(\w\w*)"/) {|matchdata| matchdata[1] }
+    end
+
+  end
+
+end

data/lib/columns/table.rb

@@ -0,0 +1,47 @@
+module Columns
+
+  # Public: Represents data for the tables found in schema.
+  class Table
+
+    # Public:
+    #
+    # schema - The db/schema.rb as a String.
+    def initialize(schema)
+      # Records the original schema file. TODO See if it's really needed.
+      @schema = schema
+      @schema_lines = schema.split("\n")
+    end
+
+    # Public: Find the table names.
+    #
+    # Returns an Array of String.
+    def names
+      @schema_lines.map {|line| Regex.table_name(line) }.compact
+    end
+
+    # Public: Get the column names and types for a given table.
+    #
+    # name - The String name of the desired table.
+    #
+    # Returns a String with the raw content of the given table section
+    #   from the schema file.
+    #
+    # TODO Sure it's better to parse the schema only once in #initialize.
+    def content_for(name)
+      found = false
+      result = ''
+      @schema_lines.each do |line|
+        if Regex.table_name(line) == name
+          found = true
+          next
+        end
+        if found
+          break if line =~ /\w*end$/
+          result << line + "\n"
+        end
+      end
+      result
+    end
+  end
+
+end

data/lib/columns/version.rb

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

data/lib/columns.rb

@@ -0,0 +1,11 @@
+require "columns/version"
+require "columns/table"
+require "columns/regex"
+require "columns/raw_data"
+require "columns/model_data"
+require "columns/model_cleaner"
+require "columns/model_writer"
+require "columns/extended_content"
+
+module Columns
+end

data/spec/extended_content_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ExtendedContent do
+
+  it 'add meta data to the content' do
+    content = "#  foo integer\n"
+    extended_content = ExtendedContent.from(content)
+    expect(extended_content).to eq %q(# == Schema Information
+#
+#  foo integer
+)
+  end
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,43 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20140522124819) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "assignments", force: true do |t|
+    t.integer "foo"
+    t.string  "bar"
+  end
+
+  add_index "assignments", ...
+  add_index "assignments", ...
+
+  create_table "products", force: true do |t|
+  end
+
+# Bla bla bla
+# Bla bla bla
+# Bla bla bla
+
+  create_table "users", force: true do |t|
+    t.integer "id",                   null: false
+    t.string  "name"
+  end
+
+  create_table "users_3", id: false, force: true do |t|
+    t.string  "name"
+  end
+
+end
+

data/spec/fixtures/user_cleaned

@@ -0,0 +1,4 @@
+class User
+
+end
+

data/spec/fixtures/user_filled

@@ -0,0 +1,7 @@
+class User
+
+end
+
+# == Schema Information
+#
+#  foo integer

data/spec/model_cleaner_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ModelCleaner do
+
+  before do
+    create_user_rb
+  end
+
+  after do
+    remove_user_rb
+  end
+
+  it 'cleans a ruby model' do
+    ModelCleaner.clean(user_rb_path)
+    expect(user_rb_file).to eq user_cleaned_file
+  end
+
+  it 'silently fail if the file does not exist' do
+    expect{
+      ModelCleaner.clean('~/does_not_exist_file_123412341234.rb')
+    }.not_to raise_error
+  end
+end

data/spec/model_data_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe ModelData do
+
+  before do
+    table = Table.new(schema_file)
+    raw = RawData.new('assignments', table.content_for('assignments'))
+    @subject = ModelData.new(raw)
+  end
+
+  it 'provides the name of the model' do
+    expect(@subject.name).to eq 'assignment'
+  end
+
+  it 'provides a «ready to paste» column names/types' do
+    content = "#  integer \"foo\"\n#  string  \"bar\"\n"
+    expect(@subject.content).to eq content
+  end
+end
+

data/spec/model_writer_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe ModelWriter do
+
+  before do
+    remove_user_rb
+    create_clean_user_rb
+  end
+
+  it 'writes schema info to the end of a file' do
+    writer = ModelWriter.new(path: fixtures_path)
+    data = instance_double(ModelData, name: 'user', content: "#  foo integer\n")
+
+    writer.add_info(data)
+
+    expect(user_rb_file).to eq user_filled_file
+  end
+
+  describe 'IO errors' do
+    
+    let(:unknown_file) { File.join(fixtures_path, 'unknown.rb') }
+
+    after { FileUtils.rm_f(unknown_file) }
+
+    it 'silently fail if the file does not exist' do
+      writer = ModelWriter.new(path: fixtures_path)
+      data = instance_double(ModelData, name: 'unknown', content: "\n")
+
+      expect{ writer.add_info(data) }.not_to raise_error
+      expect(File.exists?(unknown_file)).to eq false
+    end
+  end
+
+end

data/spec/raw_data_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe RawData do
+
+  before do
+    table = Table.new(schema_file)
+    @subject = RawData.new('assignments', table.content_for('assignments'))
+  end
+
+  it 'stores the raw table name' do
+    expect(@subject.name).to eq 'assignments'
+  end
+
+  it 'stores the raw content of the table' do
+    content = "    t.integer \"foo\"\n    t.string  \"bar\"\n"
+    expect(@subject.content).to eq content
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'coco'
+require 'fileutils'
+
+require_relative '../lib/columns'
+include Columns
+
+def fixtures_path
+  File.expand_path(File.dirname(__FILE__) + '/fixtures')
+end
+
+def schema_file
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/schema.rb')
+  File.read(file_path)
+end
+
+def user_rb_path
+  File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')
+end
+
+def user_rb_file
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')
+  File.read(file_path)
+end
+
+def user_cleaned_file
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_cleaned')
+  File.read(file_path)
+end
+
+def user_filled_file
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_filled')
+  File.read(file_path)
+end
+
+def remove_user_rb
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')
+  FileUtils.rm_f(file_path)
+end
+
+def create_user_rb
+  src = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_filled')
+  dest = File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')
+  FileUtils.cp(src, dest)
+end
+
+def create_clean_user_rb
+  src = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_cleaned')
+  dest = File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')
+  FileUtils.cp(src, dest)
+end

data/spec/table_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Table do
+
+  before { @table = Table.new(schema_file) }
+
+  it 'find the right count of tables in the schema' do
+    expect(@table.names.size).to eq 4
+  end
+
+  it 'find the right count of tables in a fake schema' do
+    schema = "create_table \"foos\"\nt.integer \"foo\"\nend"
+    expect(Table.new(schema).names.size).to eq 1
+  end
+
+  it "find the right table's names in the schema" do
+    names = ['assignments', 'products', 'users', 'users_3']
+    @table.names.each do |name|
+      expect(names.include?(name)).to be true
+    end
+  end
+
+  it "find the right table's names in a fake schema" do
+    schema = "create_table \"foos\"\nt.integer \"foo\"\nend"
+    expect(Table.new(schema).names.first).to eq 'foos'
+  end
+
+  it 'find the content of a table in a fake schema' do
+    schema = "create_table \"foos\"\nt.integer \"foo\"\nend"
+    content = Table.new(schema).content_for('foos')
+    expect(content).to eq "t.integer \"foo\"\n"
+  end
+
+  it 'find the content of a table in the schema' do
+    content = @table.content_for('assignments')
+    expected = "    t.integer \"foo\"\n    t.string  \"bar\"\n"
+    expect(content).to eq expected
+  end
+end
+

data/spec/version_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Columns do
+  it "must be defined" do
+    expect(Columns::VERSION).not_to eq nil
+  end
+end
+

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: columns
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- lkdjiin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+- !ruby/object:Gem::Dependency
+  name: coco
+  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: 
+email:
+- xavier.nayrac@gmail.com
+executables:
+- columns
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/columns
+- columns.gemspec
+- lib/columns.rb
+- lib/columns/extended_content.rb
+- lib/columns/model_cleaner.rb
+- lib/columns/model_data.rb
+- lib/columns/model_writer.rb
+- lib/columns/raw_data.rb
+- lib/columns/regex.rb
+- lib/columns/table.rb
+- lib/columns/version.rb
+- spec/extended_content_spec.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/user_cleaned
+- spec/fixtures/user_filled
+- spec/model_cleaner_spec.rb
+- spec/model_data_spec.rb
+- spec/model_writer_spec.rb
+- spec/raw_data_spec.rb
+- spec/spec_helper.rb
+- spec/table_spec.rb
+- spec/version_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- sed
+rubyforge_project: 
+rubygems_version: 2.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Annotates activerecord models using `db/schema.rb`.
+test_files:
+- spec/extended_content_spec.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/user_cleaned
+- spec/fixtures/user_filled
+- spec/model_cleaner_spec.rb
+- spec/model_data_spec.rb
+- spec/model_writer_spec.rb
+- spec/raw_data_spec.rb
+- spec/spec_helper.rb
+- spec/table_spec.rb
+- spec/version_spec.rb