ARAA 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63eba5d272d3d2ea69cdda4d6f4c816e9efe5e4a36b1f7731e41f320601dd826
+  data.tar.gz: b627cdc8413064a47de774e389e5bb9e4f47e0446c005167cedb7b3785a56b2d
+SHA512:
+  metadata.gz: a049f02bbd4d558d4f4c60e68625c98e28be9f7f8db6c24412b2eb66de06a194055c23f4978d0fae5cdf40a6aa98269a8b8954a564c67250c82959bdc28c5699
+  data.tar.gz: '091db9c3597d16a9008715c5e7e5aa5f04f95d184ae974739f41ed8e8c46f301b0eb6363b509ce5859cf913958ec0c388d9f770a167844ed35465bf23965618d'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 
+
+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,43 @@
+# App
+ARAA (ActiveRecord Auto Associate) is a Gem that allows you to dynamically build 
+your models associations without having to explicitly define them.
+
+It does this by inspecting the defined schema via ActiveRecord and populates 
+an initializer file. This file contains class declarations of your models that 
+use re-open them and defines ActiveRecord relations.
+
+This is generated via a Rake task.
+
+## Usage
+`rake araa:generate`
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'araa'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install araa
+```
+
+## Contributing
+Please feel free to contribute.
+
+At the moment, I don't know how to test this... If anyone has experience 
+testing the effects of a plugins effect on the dummy application I would 
+love the insight.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Future
+
+- [ ] Tie into Migration event and rerun

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Araa'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/araa.rb

@@ -0,0 +1,7 @@
+require "araa/railtie"
+
+module Araa
+  # Todo: Is this defined anywhere in ActiveRecord?
+  RAILS_META_TABLES = %w(schema_migrations ar_internal_metadata).freeze
+  RAILS_META_COLUMNS = %w(id created_at updated_at).freeze
+end

data/lib/araa/active_record.rb

@@ -0,0 +1,25 @@
+require 'araa/table'
+
+module Araa
+  class ActiveRecord
+    def self.filtered_application_tables
+      # Removes the rails meta tables. Only returns application defined tables.
+      ::ApplicationRecord.connection.tables.reject do |t|
+        Araa::RAILS_META_TABLES.include?(t)
+      end
+    end
+
+    def self.tables_field_map
+      table_fields = []
+
+      filtered_application_tables.each do |t|
+        table = Araa::Table.new(t)
+        table.fields.each do |field|
+          table_fields << "#{t}::#{field}"
+        end
+      end
+
+      table_fields
+    end
+  end
+end

data/lib/araa/railtie.rb

@@ -0,0 +1,7 @@
+module Araa
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'tasks/araa_tasks.rake'
+    end
+  end
+end

data/lib/araa/table.rb

@@ -0,0 +1,78 @@
+require 'araa/active_record'
+
+module Araa
+  class Table
+    attr_accessor :belongs_to,
+                  :has_many,
+                  :has_many_through
+
+    def initialize(name, build=false)
+      @name = name
+      @belongs_to = []
+      @has_one = []
+      @has_one_through = []
+      @has_many = []
+      @has_many_through = []
+      @has_and_belongs_to_many = []
+
+      if build
+        find_belongs_to
+        find_has_many
+        find_has_many_through
+      end
+    end
+
+    def table_name
+      @name
+    end
+
+    def model_name
+      table_name.singularize.camelize
+    end
+
+    def model
+      model_name.constantize
+    end
+
+    def fields
+      model.column_names.reject { |c| Araa::RAILS_META_COLUMNS.include?(c) }
+    end
+
+    def has_relations?
+      @belongs_to.any? || @has_many.any? || @has_many_through.any?
+    end
+
+    def is_habtm?
+      # a table is considered a has_and_belongs_to_many table if it only has
+      # foreign key columns.
+      fields.all? { |field| field.match(/_id$/) }
+    end
+
+    def find_belongs_to
+      fields.each { |field|
+        next unless field.match(/_id$/)
+        @belongs_to << field.gsub('_id', '')
+      }
+    end
+
+    def find_has_many(taf=Araa::ActiveRecord.tables_field_map)
+      taf.each do |table_field|
+        if Regexp.new("#{table_name.singularize}_id").match(table_field)
+          @has_many << table_field.split('::').first
+        end
+      end
+    end
+
+    def find_has_many_through(taf=Araa::ActiveRecord.tables_field_map)
+      @has_many.each do |hm|
+        associated_table = Araa::Table.new(hm)
+        associated_table.find_belongs_to
+
+        associated_table.belongs_to.each do |bt|
+          next if bt == table_name.singularize
+          @has_many_through << [bt.pluralize, hm]
+        end
+      end
+    end
+  end
+end

data/lib/araa/version.rb

@@ -0,0 +1,3 @@
+module Araa
+  VERSION = '0.1.0'
+end

data/lib/tasks/araa_tasks.rake

@@ -0,0 +1,39 @@
+require 'araa/active_record'
+require 'fileutils'
+
+namespace :araa do
+  desc 'Creates the Araa config file if it does not exist.'
+  task create_models_config: :environment do
+    path = File.join(Rails.root, 'config', 'initializers', 'araa_models.rb')
+    FileUtils.touch path
+  end
+
+  desc "Generates the associations and stores them in an initializer"
+  task generate: [:environment, :create_models_config] do
+    path = File.join(Rails.root, 'config', 'initializers', 'araa_models.rb')
+    tables_and_fields = Araa::ActiveRecord.tables_field_map
+
+    tables = Araa::ActiveRecord.filtered_application_tables.map do |t|
+      table = Araa::Table.new(t)
+      table.find_belongs_to
+      table.find_has_many(tables_and_fields)
+      table.find_has_many_through(tables_and_fields)
+      table
+    end
+
+    File.open(path, 'w') do |f|
+      tables.each do |table|
+        next unless table.has_relations?
+        f.write "class #{table.model_name} < ApplicationRecord\n"
+
+        table.belongs_to.each { |bt| f.write "\tbelongs_to :#{bt}\n" }
+        table.has_many.each { |bt| f.write "\thas_many :#{bt}\n" }
+        table.has_many_through.each { |hmt|
+          f.write "\thas_many :#{hmt[0]}, through: :#{hmt[1]}\n"
+        }
+
+        f.write "end\n\n"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: ARAA
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Turknett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Automatically build ActiveRecord relations for models based on Rails
+  conventions
+email:
+- johnturknett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/araa.rb
+- lib/araa/active_record.rb
+- lib/araa/railtie.rb
+- lib/araa/table.rb
+- lib/araa/version.rb
+- lib/tasks/araa_tasks.rake
+homepage: https://github.com/johnTurknett/araa
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: ActiveRecord Auto Associate
+test_files: []