columns 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fb05fd5b271d2da52b43da4de35438a74802cc0
-  data.tar.gz: c2a54c11f138608d8905798d32f91b75e360cc20
+  metadata.gz: 74908684891067229e04bdab34a621b9d60e803f
+  data.tar.gz: 18d28d782d48a920625c3fd3cc2de7d5dcd63941
 SHA512:
-  metadata.gz: bbf3877d98afc1460945b9641b0153c582763522b87668fc5459dbb9c2d485e608abe1d75657d2c1f45234675b03246ad28e6e7ec293b33574abd69adec95b0a
-  data.tar.gz: 830ff6fafe2c9961be383205715ee7989dde535d117d8c049995ed2d9ff755c3c04e467594a197301cd3fff22db58cfc34ac98563ce719bb79591ea6f3fd0289
+  metadata.gz: 366a8c5b0d4271b0132519dabd8585493cce531bc306348f128f6cf1448024f74a0d6829c485c28a686c8c66729466e801ccf8eaab5525dfe8f1517698c808c9
+  data.tar.gz: 1cebe951c55d2e4ce23571d14ab986d62ba90481e597d42ecfc11cf0b11359ab90322a5e9a80234d6ca1543cb888e85d1aec1061ebb256098419fbc5094e7d90

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 *.swp
+TODO

data/README.md

@@ -1,4 +1,4 @@
-# Columns
+# Columns [![Gem Version](https://badge.fury.io/rb/columns.svg)](http://badge.fury.io/rb/columns)
 
 Annotates activerecord models using `db/schema.rb`.
 
@@ -22,11 +22,21 @@ Or install it yourself as:
 
     $ cd your_project
 
-Once you have generate a `db/schema.rb`, just type
+Once you have generate a `db/schema.rb`, just type the following to
+annotate your models:
 
     $ columns
 
-to annotate your models.
+### Do it programmaticaly
+
+Instead of using Columns as a shell command, you can use it as a
+library. To do so, call the following method:
+
+``` ruby
+require 'columns'
+
+Columns.execute
+```
 
 Note that models must to reside in `app/models`.
 

data/bin/columns

@@ -2,33 +2,5 @@
 
 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
-
+Columns.execute
 

data/lib/columns/model_cleaner.rb

@@ -1,6 +1,6 @@
 module Columns
 
-  # Public: This class is responsible of removing a possible schema info
+  # 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

data/lib/columns/model_data.rb

@@ -1,6 +1,6 @@
 module Columns
 
-  # Public: Stores data about a model.
+  # Stores data about a model.
   #
   # Model name
   # ----------
@@ -20,12 +20,16 @@ module Columns
   #     #  integer "foo"
   class ModelData
 
-    # Public: Get the model's name. For a model `app/models/user.rb`,
+    # Public: Get the String model's name. For a model `app/models/user.rb`,
     # the model's name will be `user`.
     attr_reader :name
 
+    # Public: Get a String formatted content.
     attr_reader :content
 
+    # Public: Creates a new ModelData.
+    #
+    # raw_data - A RawData object.
     def initialize(raw_data)
       # Ok, this is really idiot, I know, I know. Must use inflectors in
       # the future.

data/lib/columns/model_writer.rb

@@ -1,12 +1,23 @@
 module Columns
 
-  # Public: Add schema info to the end of a ruby model.
+  # Add schema info to the end of a ruby model.
   class ModelWriter
 
+    # Public: Creates a new ModelWriter.
+    #
+    # path - String relative or absolute path to the models directory.
+    #        It's handy to be able to change the path during tests.
+    #        Default is './app/models/'.
     def initialize(path: './app/models/')
       @path = path
     end
 
+    # Public: Puts model data and meta data to the end of a model file.
+    #
+    # model_data - A ModelData, used to deduce the model file and to
+    #              grab data.
+    #
+    # Returns nothing.
     def add_info(model_data)
       @model_data = model_data
       ensure_file_end_with_empty_line

data/lib/columns/raw_data.rb

@@ -1,9 +1,20 @@
 module Columns
 
-  # Public: A simple object to store raw data about a table.
+  # A simple object to store raw data about a table.
   class RawData
-    attr_reader :name, :content
 
+    # Public: Get the String table's name.
+    attr_reader :name
+
+    # Public: Get the String table's content, i.e column's names and
+    #   types.
+    attr_reader :content
+
+    # Public: Creates a new RawData.
+    #
+    # name    - A String table's name.
+    # content - A String content related to the table, directly grabbed
+    #           from a `schema.rb`.
     def initialize(name, content)
       @name = name
       @content = content

data/lib/columns/table.rb

@@ -1,22 +1,19 @@
 module Columns
 
-  # Public: Represents data for the tables found in schema.
+  # Represents data for the tables found in schema.
   class Table
 
-    # Public:
+    # Public: Find the table names.
+    #
+    # Returns an Array of String.
+    attr_reader :names
+
+    # Public: Creates a new Table.
     #
     # 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
+      @names = @schema_lines.map {|line| Regex.table_name(line) }.compact
     end
 
     # Public: Get the column names and types for a given table.

data/lib/columns/version.rb

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

data/lib/columns.rb

@@ -7,5 +7,66 @@ require "columns/model_cleaner"
 require "columns/model_writer"
 require "columns/extended_content"
 
+# Public: Columns annotate your activerecord models from a `schema.rb` file.
+# That could be handy when your application don't use Rails.
 module Columns
+
+  # Public: Annotate models.
+  #
+  # schema_dir - String directory (absolute or relative) to find the
+  #              `schema.rb` file. Default is `./db/`.
+  # models_dir - String directory (absolute or relative) to find the
+  #              models. Default is `./app/models/`.
+  #
+  # Returns nothing.
+  #
+  # Raises SystemExit if the `schema.rb` doesn't exist.
+  def self.execute(schema_dir: './db/', models_dir: './app/models/')
+    application = Application.new(schema_dir, models_dir)
+    application.execute
+  end
+
+  private
+
+  # The tool chain.
+  class Application
+
+    # Creates a new Application.
+    #
+    # See Columns.execute for arguments.
+    #
+    # Raises SystemExit if it can't find the `schema.rb`.
+    def initialize(schema_dir, models_dir)
+      @models_dir = models_dir
+      schema_path = File.expand_path(File.join(schema_dir,'schema.rb'))
+
+      unless File.exists?(schema_path)
+        puts "COLUMNS ERROR : #{schema_path} doesn't exist!"
+        exit 1
+      end
+      table = Table.new(File.read(schema_path))
+
+      raw_data_objects = []
+      table.names.each do |name|
+        raw_data_objects << RawData.new(name, table.content_for(name))
+      end
+
+      @model_data_objects = raw_data_objects.map do |object|
+        ModelData.new(object)
+      end
+    end
+
+    # Cleans then writes models.
+    #
+    # Returns nothing.
+    def execute
+      writer = ModelWriter.new(path: @models_dir)
+      @model_data_objects.each do |object|
+        path = File.expand_path(File.join(@models_dir, object.name) + '.rb')
+        ModelCleaner.clean(path)
+        writer.add_info(object)
+      end
+    end
+
+  end
 end

data/spec/fixtures/integration/user_filled

@@ -0,0 +1,8 @@
+class User
+
+end
+
+# == Schema Information
+#
+#  integer "id",                   null: false
+#  string  "name"

data/spec/integration/columns_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Columns do
+
+  describe 'executes the application' do
+    before { create_clean_user_rb }
+    after { remove_user_rb }
+
+    specify 'on virgin models', :speed => 'slow' do
+      schema_dir = 'spec/fixtures'
+      models_dir = 'spec/fixtures'
+
+      Columns.execute(schema_dir: schema_dir, models_dir: models_dir)
+
+      expect(user_rb_file).to eq integration_user_filled_file
+    end
+
+    skip 'on already annotated models', :speed => 'slow' do
+    end
+
+  end
+
+  context 'when there is no schema' do
+    it 'exits with status code 1', :speed => 'slow' do
+      schema_dir = 'spec/'
+      models_dir = 'spec/fixtures'
+
+      begin
+        Columns.execute(schema_dir: schema_dir, models_dir: models_dir)
+      rescue SystemExit => ex
+        expect(ex.status).to eq 1
+      end
+    end
+  end
+end

data/spec/model_writer_spec.rb

@@ -2,10 +2,8 @@ require 'spec_helper'
 
 describe ModelWriter do
 
-  before do
-    remove_user_rb
-    create_clean_user_rb
-  end
+  before { create_clean_user_rb }
+  after { remove_user_rb }
 
   it 'writes schema info to the end of a file' do
     writer = ModelWriter.new(path: fixtures_path)

data/spec/spec_helper.rb

@@ -5,46 +5,52 @@ require_relative '../lib/columns'
 include Columns
 
 def fixtures_path
-  File.expand_path(File.dirname(__FILE__) + '/fixtures')
-end
+  File.expand_path(File.dirname(__FILE__) + '/fixtures')# {{{
+end# }}}
 
 def schema_file
-  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/schema.rb')
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/schema.rb')# {{{
   File.read(file_path)
-end
+end# }}}
 
 def user_rb_path
-  File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')
-end
+  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_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')# {{{
   File.read(file_path)
-end
+end# }}}
 
 def user_cleaned_file
-  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_cleaned')
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_cleaned')# {{{
   File.read(file_path)
-end
+end# }}}
 
 def user_filled_file
-  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_filled')
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_filled')# {{{
   File.read(file_path)
-end
+end# }}}
+
+def integration_user_filled_file
+  file_path = File.expand_path(File.dirname(__FILE__) +# {{{
+              '/fixtures/integration/user_filled')
+  File.read(file_path)
+end# }}}
 
 def remove_user_rb
-  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/user.rb')# {{{
   FileUtils.rm_f(file_path)
-end
+end# }}}
 
 def create_user_rb
-  src = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_filled')
+  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
+end# }}}
 
 def create_clean_user_rb
-  src = File.expand_path(File.dirname(__FILE__) + '/fixtures/user_cleaned')
+  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
+end# }}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: columns
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - lkdjiin
@@ -106,9 +106,11 @@ files:
 - lib/columns/table.rb
 - lib/columns/version.rb
 - spec/extended_content_spec.rb
+- spec/fixtures/integration/user_filled
 - spec/fixtures/schema.rb
 - spec/fixtures/user_cleaned
 - spec/fixtures/user_filled
+- spec/integration/columns_spec.rb
 - spec/model_cleaner_spec.rb
 - spec/model_data_spec.rb
 - spec/model_writer_spec.rb
@@ -146,9 +148,11 @@ specification_version: 4
 summary: Annotates activerecord models using `db/schema.rb`.
 test_files:
 - spec/extended_content_spec.rb
+- spec/fixtures/integration/user_filled
 - spec/fixtures/schema.rb
 - spec/fixtures/user_cleaned
 - spec/fixtures/user_filled
+- spec/integration/columns_spec.rb
 - spec/model_cleaner_spec.rb
 - spec/model_data_spec.rb
 - spec/model_writer_spec.rb