active_recorder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5abf615aff84554c27a041a67348ba25be5aa1b8
+  data.tar.gz: 0d1c4284804446e71b691cb395ad6e7308ecf924
+SHA512:
+  metadata.gz: c1f35777e8b4fc1ce7040f0e7c94bf240a810ffb75cb179ca1093e8719b75a3c87a5d05b1751bab2aa30550b3be96cd36fb71d6a39b0358a05978c724a3e174f
+  data.tar.gz: 56cb13a0bbcab62027be5bb3907c2b79a712f42ba4c4f17fcded4397fe78d07b8ba3c8a445aef7282418bba7c65468f6b549e7c6ab0192debf25eeb4bdd844c7

data/lib/active_recorder.rb

@@ -0,0 +1,18 @@
+require 'active_recorder/filereader'
+require 'active_recorder/filewriter'
+require 'active_recorder/record'
+# Main class for ActiveRecorder gem
+class ActiveRecorder
+  def self.record(path)
+    # Add a tables route to routes.rb
+    Filewriter.write_routes(path)
+    # Get all the records from the
+    records = Filereader.construct_records(path)
+    # Construct tables_controller.rb
+    Filewriter.write_controller(path, records)
+    # Create a tables directory
+    Filewriter.create_tables_dir(path)
+    # Create a index file for tables
+    Filewriter.write_view(path, records)
+  end
+end

data/lib/active_recorder/filereader.rb

@@ -0,0 +1,109 @@
+# A Filereader module which creates Records based on migration files
+module Filereader
+  # Takes in directory with migrations and returns array of records created
+  def self.construct_records(path)
+    # Initialize array of records
+    records = []
+    # Iterates through every file in a directory
+    dir = File.join(path, 'db/migrate')
+    Dir.foreach(dir) do |file|
+      next if file.start_with?('.')
+      # Append to records
+      records << Filereader.construct_record(Filereader.to_absolute_path(dir, file))
+    end
+    records
+  end
+
+  # Takes in a filename as input and constructs a Record
+  def self.construct_record(filename)
+    # Get migration file information
+    record_info = Filereader.get_initial_line(filename)
+    # Check if file was a valid migration file
+    fail ArgumentError, 'Not a migration file' if record_info.empty?
+    columns_info = Filereader.get_columns(filename, record_info['var_name'])
+    # Create a new record
+    record = Record.new(record_info['record_name'])
+    # Add hashed to record
+    columns_info.each { |column, type| record.add_column(column, type) }
+    record
+  end
+
+  # Takes in a filename and gets the column lines of the file
+  def self.get_columns(filename, var_name)
+    # Initialize a column array
+    columns = {}
+    # Opens file and retrieve column lines
+    File.open(filename).each do |line|
+      # Strip line
+      strs = line.strip!.split
+      # Adds column lines hash
+      if line.start_with?(var_name)
+        strs[1] = strs[1].slice(0, strs[1].length - 1) if strs[1].end_with?(',')
+        type = Filereader.to_data_type(strs[0], var_name)
+        columns[Filereader.to_column_name(strs[1])] = type if type != 'timestamps'
+      end
+      # Check if reach end
+      break if line.strip! == 'end'
+    end
+    columns
+  end
+
+  # Takes in a filename and gets the initial line information
+  def self.get_initial_line(filename)
+    # Initialize a hash
+    hash = {}
+    # Opens file and retrieve initial line
+    File.open(filename).each do |line|
+      # Strip line
+      strs = line.strip!.split
+      # Adds initial line
+      next unless !strs[0].nil? && strs[0].start_with?('create_table')
+      # Check if we reached end
+      hash['record_name'] = Filereader.to_record_name(strs[1])
+      hash['var_name'] = Filereader.to_variable_name(strs[3])
+      break
+    end
+    hash
+  end
+
+  # Convert to variable name
+  def self.to_variable_name(var)
+    var[1, var.length - 2]
+  end
+
+  # Convert table name to Entity name
+  def self.to_record_name(name)
+    entity_name = name[1, name.length - 2].capitalize
+    # Check if name has '_'
+    if name.include? '_'
+      entity_name = Filereader.to_association_record_name(name)
+    elsif name.end_with?('ses')
+      entity_name = name[1, name.length - 3].capitalize
+    end
+    entity_name
+  end
+
+  # Get association table name
+  def self.to_association_record_name(name)
+    split = name.split('_')
+    name = "#{split[0].slice(1, split[0].length).capitalize}#{split[1].capitalize}"
+    entity_name = name[0, name.length - 1]
+    entity_name = name[0, name.length - 2] if name.end_with?('ses')
+    entity_name
+  end
+
+  # Convert to column name
+  def self.to_data_type(col, var_name)
+    col[var_name.length + 1, col.length - var_name.length]
+  end
+
+  # Convert to data type
+  def self.to_column_name(type)
+    type[1, type.length - 1]
+  end
+
+  # Convert to absolute path
+  def self.to_absolute_path(dir, file)
+    "#{dir}/#{file}"
+  end
+end

data/lib/active_recorder/filewriter.rb

@@ -0,0 +1,120 @@
+require 'fileutils'
+# A Filereader module which create a controller and view for ActiveRecord tables
+module Filewriter
+  # Creates controller in the directory given
+  def self.write_controller(path, records)
+    # Get the absolute path to write the controller
+    dir = File.join(path, 'app/controllers/tables_controller.rb')
+    open(dir, 'w') do |f|
+      # Prints class declaration
+      f.puts 'class TablesController < ApplicationController'
+      # Prints comment
+      f.puts '  # GET /tables'
+      # Prints route function
+      f.puts '  def index'
+      # Prints out entities instance variable and function call
+      records.each do |record|
+        f.puts "    #{Filewriter.to_instance_variable(record.name)} = #{Filewriter.to_all(record.name)}"
+      end
+      f.puts '  end'
+      f.puts 'end'
+    end
+  end
+
+  # Creates a tables view in the directory given
+  def self.write_view(path, records)
+    # Get the absolute path to write the view
+    dir = File.join(path, 'app/views/tables/index.html.erb')
+    open(dir, 'w') do |f|
+      # Print headers
+      f.puts '<!DOCTYPE HTML>'
+      f.puts '<html lang="en">'
+      f.puts '  <head>'
+      f.puts '    <title>ActiveRecord Tables</title>'
+      f.puts '    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous">'
+      f.puts '  </head>'
+      f.puts '  <body>'
+      f.puts '    <h1 align="center">ActiveRecord Tables</h1>'
+      # Print record tables
+      records.each do |record|
+        f.puts '    <div class="container col-md-offset-2 col-md-8">'
+        f.puts "      <h3 align='center' style='margin-top:30px'>#{Filewriter.pluralize(record.name)} Table</h3>"
+        f.puts '      <table class="table table-bordered">'
+        f.puts '        <thead>'
+        f.puts '          <tr class="info">'
+        f.puts '            <th>ID</th>'
+        record.columns.each do |col, _val|
+          f.puts "            <th>#{col.capitalize}</th>"
+        end
+        f.puts '          </tr>'
+        f.puts '        </thead>'
+        f.puts '        <tbody>'
+        f.puts "          <% #{Filewriter.to_instance_variable(record.name)}.each do |#{record.name.downcase}| %>"
+        f.puts '            <tr>'
+        f.puts "              <td><%= #{record.name.downcase}.id %></td>"
+        record.columns.each do |col, val|
+          if val == 'references'
+            f.puts "              <td><%= #{record.name.downcase}.#{col}.id %></td>"
+          else
+            f.puts "              <td><%= #{record.name.downcase}.#{col} %></td>"
+          end
+        end
+        f.puts '            </tr>'
+        f.puts '          <% end %>'
+        f.puts '        </tbody>'
+        f.puts '      </table>'
+        f.puts '    </div>'
+      end
+      f.puts '  </body>'
+      f.puts '</html>'
+    end
+  end
+
+  # Writes the tables routes to the routes.rb file
+  def self.write_routes(path)
+    # Get input and output directory of files
+    input = "#{File.join(path, 'config')}/routes.rb"
+    output = "#{File.join(path, 'config')}/tmp.rb"
+    # Open the file to read from
+    open(input, 'r') do |input_file|
+      open(output, 'w') do |output_file|
+        # Read each line of input
+        input_file.each_line do |line|
+          if line.start_with? 'end'
+            output_file.puts("  get 'tables' => 'tables#index'")
+            output_file.puts('end')
+          else
+            output_file.write(line)
+          end
+        end
+      end
+    end
+    # Overwrite input with output
+    FileUtils.mv(output, input)
+  end
+
+  # Prepends '@' and appends 's' to a lower case variable name
+  def self.to_instance_variable(name)
+    instance_name = "@#{name.downcase}s"
+    instance_name = "@#{name.downcase}es" if name.end_with?('s')
+    instance_name
+  end
+
+  # Appends '.all' to a records name
+  def self.to_all(name)
+    "#{name}.all"
+  end
+
+  # Appends 's' to a records name
+  def self.pluralize(name)
+    pluralized = "#{name}s"
+    pluralized = "#{name}es" if name.end_with?('s')
+    pluralized
+  end
+
+  # Creates a directory with the given path
+  def self.create_tables_dir(path)
+    dir = File.join(path, 'app/views/tables')
+    Dir.mkdir dir
+  end
+end

data/lib/active_recorder/record.rb

@@ -0,0 +1,29 @@
+# An record class to represent an ActiveRecord table
+class Record
+  # Instance variable: name of the Model using table
+  attr_reader :name
+  attr_accessor :columns
+  # Array with valid ActiveRecord datatypes
+  VALID_TYPES = %w(
+    binary boolean date datetime decimal float integer
+    primary_key references string text time timestamp
+  ).freeze
+
+  # Record constructor to initialize Record with name
+  def initialize(name)
+    # Validate name
+    fail ArgumentError, 'Name cannot be nil!' if name.nil?
+    fail ArgumentError, 'Name cannot be empty!' if name.empty?
+    # Initialize name and columns
+    @name = name
+    @columns = {}
+  end
+
+  # Adds a column to record
+  def add_column(col, type)
+    # Check whether the column added is a valid ActiveRecord type
+    fail ArgumentError, 'Invalid ActiveRecord datatype!' unless VALID_TYPES.include?(type)
+    # Add column to record
+    @columns[col] = type
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: active_recorder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Goh Chin Loong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: The gem creates a view, controller and routes to allow Rails developers
+  to see their ActiveRecord tables.
+email:
+- gohchinloong@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_recorder.rb
+- lib/active_recorder/filewriter.rb
+- lib/active_recorder/filereader.rb
+- lib/active_recorder/record.rb
+homepage: http://www.github.com/chinloong93
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A Ruby gem which visualizes ActiveRecord tables and rows for Rails apps.
+test_files: []