datagaze 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40843266b1b5f1b3b5e42c8b86d0df281a507bed943fe2cfb93f1ad2ac9a90d3
+  data.tar.gz: ded9dd284b9e1a42ecfb19718ebfe0b9ba854ff08e0e9679c21ab65037c9b679
+SHA512:
+  metadata.gz: b237da054b7831101b4fb0a1d653743a3a16159f43aa433d5a8551651bdf6d45c71be10686def2da01013ac4e60213c9cdf9b9b7394212d9294127c0cf2f1731
+  data.tar.gz: c4ad5939241100066d3f862a695595f9c81c4e5b0faff315ed88352ce3399051b5e946b1fca5024d4fd2452542b20653bd52a4fbd2d95d2cc6e4e96f15e125f2

data/Gemfile

@@ -0,0 +1,5 @@
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    datagaze (0.0.1)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  datagaze!
+  pry
+
+BUNDLED WITH
+   2.2.27

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Jurriaan Schrofer
+
+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,115 @@
+
+# Datagaze
+
+Look at your database without ever leaving your model. Yay!
+
+`datagaze` dynamically inserts and updates schema information into your Rails models, which in effect prevents you from having to visit schema.rb and helps other developers to quickly grasp the nature of your models.
+
+If you are curious what problems are fixed by `datagaze` (which are prevalent in other gems, such as `annotate`) skip down some sections below.
+
+# Overview
+
+## Sneak preview
+
+```ruby
+
+# app/models/user.rb
+
+=begin
+
+== Schema information for table 'users'
+
+column_name     column_type     column_default     
+
+id              integer         -                  
+first_name      string          -                  
+last_name       string          -
+confirmed       boolean         false
+created_at      datetime        -                  
+updated_at      datetime        -                  
+
+=end
+
+class User < ApplicationRecord
+
+  # Just your User model contents, as it already is.
+
+end
+
+```
+
+## Installation
+
+Using Rubygems in your gemfile:
+```ruby
+group :development do
+  gem 'datagaze'
+end
+```
+
+Or, alternatively, using Github in your gemfile:
+```ruby
+group :development do
+  gem 'datagaze', git: 'https://github.com/jurriaanschrofer/datagaze'
+end
+```
+
+Afterwards, run the following command in the root of your project directory. This enables datagaze to update your models automatically on every future migration.
+
+```
+$ bundle exec datagaze install
+```
+
+## Usage
+
+Besides the installation command listed above (which enables datagaze to automatically update your models on every future migration) datagaze provides you with three other commands:
+
+Run datagaze by hand with:
+```
+$ bundle exec datagaze models
+```
+
+Remove all informational tables created by datagaze with:
+```
+$ bundle exec datagaze remove
+```
+
+Uninstall datagaze (and prevent it from running automatically) with:
+```
+$ bundle exec datagaze uninstall
+```
+
+# vs. Annotate
+
+## The problem of the annotate gem
+
+The wildly popular `annotate` gem (which is awesome, thanks guys) has a fundamental flaw, which `datagaze` fixes:
+
+Annotate requires that your project has one single directory for all models (by default the `app/models` directory). Any models that are not placed in this directory, will produce an error and prevent ALL models from being annotated. 
+
+For some this may just be fine – but for the many who are maintaining larger applications, gems or simply projects that require flexibility, this is breaking.
+
+## The fix by datagaze
+
+Instead of relying on a rigid file structure, datagaze combines ruby's dynamic `const_source_location` with rails' dynamic `ApplicationRecord.descendants`. 
+
+In effect, datagaze is able to dynamically trace the location of ANY model that inherits from ApplicationRecord, no matter where it is hidden in your project.
+
+## datagaze vs. annotate
+
+Whilst this approach is crucial to some, annotate is better for others. So let's make a fair comparision:
+
+### Why datagaze is better
+
+- Datagaze handles all models irregardless of their source location, thereby putting no constraints on your project.
+- Datagaze has a substantially smaller memory footprint than annotate.
+- Datagaze is simpler to use: due to configuration being absent, you just have install the gem and run `bundle exec datagaze install` once.
+- Datagaze's source code is much easier to customize or fork (sorry folks, annotate's code base is a mess).
+
+### Why annotate is better
+
+- Datagaze relies on ruby's `const_source_location` method, which was only released in ruby 2.7. If you operate below, you can't use datagaze.
+- Annotate has more configurable options (pull requests are welcome though).
+
+
+

data/bin/datagaze

@@ -0,0 +1,20 @@
+
+require 'datagaze'
+require 'optparse'
+require './config/environment'
+
+if ARGV.include?("install")
+  Rake::Task[:install].invoke
+
+elsif ARGV.include?("uninstall")
+  Rake::Task[:uninstall].invoke
+
+elsif ARGV.include?("models")
+  Rake::Task[:datagaze_models].invoke
+
+elsif ARGV.include?("remove")
+  Rake::Task[:datagaze_remove].invoke
+
+else
+  raise ArgumentError, "no valid rake task argument was given, options are: 'models', 'remove'"
+end

data/lib/datagaze/models/models/base.rb

@@ -0,0 +1,70 @@
+module Datagaze::Models
+  class << self
+
+    # The method that creates all annotations
+    def annotate_all_models
+      collect_all_models.each do |model, atts|
+        annotate_one_model(model: model, **atts.slice(:path, :table_name) )
+      end
+    end
+
+    # The method that removes all annotations, if desired
+    def clean_all_annotations
+      collect_all_models.each do |model, atts|
+        clean_one_model(model: model, **atts.slice(:path) )
+      end
+    end
+
+    private
+
+    def annotate_one_model(model:, path:, table_name:)
+      @model      = model
+      @path       = path
+      @table_name = table_name
+      @columns    = columns
+      @contents   = generate_schema_information
+
+      File.open(path, "w+") { _1 << @contents }
+    end
+
+    def clean_one_model(model:, path:)
+      @model    = model
+      @path     = path
+      @contents = exisiting_file_contents
+
+      File.open(path, "w+") { _1 << @contents }
+    end
+
+    def generate_schema_information
+      begin_of_comment        + 
+      informational_header    + 
+      table_information       + 
+      end_of_comment          + 
+      exisiting_file_contents
+    end
+
+    def columns
+      columns = ApplicationRecord.connection.columns(@table_name)
+      sort_columns(columns)
+    end
+
+    def sort_columns(columns)
+      columns.sort_by { _1.name }
+    end
+
+    def table_information
+      @columns.map { column_information(_1) }.join("\n")
+    end
+
+    def exisiting_file_contents
+      file_contents = File.read(@path)
+      remove_previous_annotation(file_contents)
+    end
+
+    def remove_previous_annotation(file_contents)
+      annotation_matcher = /^=begin\n\n== Schema information.*^?(?=class)/m
+      file_contents.gsub(annotation_matcher, '')
+    end
+
+  end
+end

data/lib/datagaze/models/models/fixed_text_elements.rb

@@ -0,0 +1,25 @@
+module Datagaze::Models
+  class << self
+
+    private
+
+    def begin_of_comment
+      <<~EOL
+        =begin
+
+        == Schema information for table '#{@table_name}'
+
+      EOL
+    end
+
+    def end_of_comment
+    <<~EOL
+
+
+      =end
+
+      EOL
+    end
+
+  end
+end

data/lib/datagaze/models/models/get_all_model_constants.rb

@@ -0,0 +1,20 @@
+module Datagaze::Models
+  class << self
+
+    def collect_all_models     
+      
+      models = ApplicationRecord.descendants.select { |model| !model.abstract_class? }
+      
+      models.map do |model|
+       
+        path, line_no = ApplicationRecord.const_source_location(model.to_s)
+        table_name    = model.table_name
+        
+        { model => { path: path, table_name: table_name } }
+
+      end.reduce(&:merge)
+
+    end
+
+  end
+end

data/lib/datagaze/models/models/print_schema_information.rb

@@ -0,0 +1,47 @@
+module Datagaze::Models
+  class << self
+  
+    ColumnPadding = 5
+    
+    private
+
+    def informational_header
+      name_header    = "column_name".ljust(name_column_width)
+      type_header    = "column_type".ljust(type_column_width)
+      default_header = "column_default".ljust(default_column_width)
+      returns        = "\n\n"
+      name_header + type_header + default_header + returns
+    end
+
+    def name_column_width  
+      [*@columns.map { _1.name.length }, "column_name".length].compact.max + ColumnPadding
+    end
+
+    def type_column_width
+      [*@columns.map { _1.type.to_s.length }, "column_type".length].compact.max + ColumnPadding      
+    end
+
+    def default_column_width
+      [*@columns.map { _1.default&.length }, "column_default".length].compact.max + ColumnPadding
+    end
+
+    def name_column_value
+      (@column.name || "-").ljust(name_column_width)
+    end
+
+    def type_column_value
+      (@column.type.to_s || "-").ljust(type_column_width)
+    end
+
+    def default_column_value
+      (@column.default || "-").ljust(default_column_width)
+    end
+
+    def column_information(column)
+      @column = column
+      name_column_value + type_column_value + default_column_value
+    end
+
+
+  end
+end

data/lib/datagaze/models/models.rb

@@ -0,0 +1,5 @@
+
+require_relative "models/base"
+require_relative "models/get_all_model_constants"
+require_relative "models/print_schema_information"
+require_relative "models/fixed_text_elements"

data/lib/datagaze/version.rb

@@ -0,0 +1,6 @@
+
+module Datagaze
+
+  VERSION = '0.0.1'
+
+end

data/lib/datagaze.rb

@@ -0,0 +1,10 @@
+module Datagaze
+
+  require 'rake'
+
+  require_relative "datagaze/version"
+  require_relative "datagaze/models/models"
+  require_relative "tasks/datagaze_models"
+  require_relative "tasks/installation"
+
+end

data/lib/tasks/datagaze_models.rb

@@ -0,0 +1,16 @@
+require_relative "../datagaze/models/models"
+
+desc "Adds a table representation to your model files."
+task :datagaze_models do
+  puts "Datagaze is adding table representations to your model files..."
+  Rails.application.eager_load!
+  Datagaze::Models.annotate_all_models
+end
+
+desc "Removes the table representation from your model files."
+task :datagaze_remove do
+  puts "Datagaze is removing table representations from your model files..."
+  Rails.application.eager_load!
+  Datagaze::Models.clean_all_annotations
+end
+

data/lib/tasks/installation.rb

@@ -0,0 +1,36 @@
+=begin 
+
+Instead of using Rails generators to run the gem's installation (and thereby 
+requiring a railtie), we simply copy and paste the required file into the
+main application's lib directory ourselves. Doing so will add hooks to all
+migration rake tasks as provided by rails, effectively running `bundle exec
+datagaze models` everytime a database operation is performed.
+
+=end
+
+desc "Install datagaze and let it run on every migration."
+task :install do
+ 
+  puts "Datagaze is enabling to automatically run on every future migrations..."
+
+  require './config/environment'
+
+  source_path      = File.expand_path('../templates/datagaze_on_migration.rake', __FILE__)
+  destination_path = Rails.root.join('lib/tasks/datagaze_on_migration.rake')
+
+  `cp #{source_path} #{destination_path}`
+
+end
+
+desc "Uninstall datagaze and prevent it from running on every migration."
+task :uninstall do
+
+  puts "Datagaze is uninstalling and stops to automatically run on future migrations..."
+
+  require './config/environment'
+
+  installation_path = Rails.root.join('lib/tasks/datagaze_on_migration.rake')
+
+  `rm #{installation_path}`
+
+end

data/lib/tasks/templates/datagaze_on_migration.rake

@@ -0,0 +1,20 @@
+
+# Using an initializtion rake task, this file somehow needs to be copied
+# to the main application's app/lib/tasks directory
+
+if Kernel.const_defined?("Rails::Application") && Rails::VERSION::MAJOR >= 6
+  
+  require "active_record"
+
+  migration_tasks = %w( db:migrate db:migrate:up db:migrate:down db:migrate:reset 
+                        db:migrate:redo db:rollback )
+
+  migration_tasks.each do |task|
+
+    next unless Rake::Task.task_defined?(task)
+    
+    Rake::Task[task].enhance do
+      Rake::Task['datagaze_models'].invoke
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: datagaze
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jurriaan Schrofer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Take a look at your database without ever leaving your models.
+email:
+- jschrofer@gmail.com
+executables:
+- datagaze
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- bin/datagaze
+- lib/datagaze.rb
+- lib/datagaze/models/models.rb
+- lib/datagaze/models/models/base.rb
+- lib/datagaze/models/models/fixed_text_elements.rb
+- lib/datagaze/models/models/get_all_model_constants.rb
+- lib/datagaze/models/models/print_schema_information.rb
+- lib/datagaze/version.rb
+- lib/tasks/datagaze_models.rb
+- lib/tasks/installation.rb
+- lib/tasks/templates/datagaze_on_migration.rake
+homepage: https://github.com/jurriaanschrofer/datagaze
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jurriaanschrofer/datagaze
+  source_code_uri: https://github.com/jurriaanschrofer/datagaze
+  changelog_uri: https://github.com/jurriaanschrofer/datagaze
+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: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Take a look at your database without ever leaving your models.
+test_files: []