active_record_analyzer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 077c4ceaaef76f919c954c872faf2cdc116e28bc
+  data.tar.gz: 4e208e5ba80873246ee658f375e23667046e5251
+SHA512:
+  metadata.gz: 2e5b31c24a97665b4945a5ab0654824afd6eb434df41f1873b59bfc837caeadf96afcd4dd5c3dadcc9ac90a5acb5fc98c0f7a822ce59e883c6f3ba403288076e
+  data.tar.gz: 2b894968e7180d3a7505e34aeb0fd90f3fd0d90b3d6012648e5a94b3df9b13ee2904fc9f0fd87faf85851ea59ba1e4eb2760325f14066b75c5128ddda572927a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record_analyzer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ariel Scherman
+
+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,77 @@
+# ActiveRecordAnalyzer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_record_analyzer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_analyzer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_analyzer
+
+## Usage
+
+You can analyze your ActiveRecord model with the analyzer:
+
+```ruby
+analyzer = ActiveRecordAnalyzer::Analyzer.new(User)
+```
+
+With the analyzer in place, given an attribute's name, you can get its type for the given class (`User` in the example):
+
+```ruby
+attribute = analyzer.reflect(:name)
+attribute.association?      # => false
+attribute.simple_attribute? # => true
+```
+
+### Simple attributes
+
+A **Simple Attribute** means basically every attribute except of foreign keys.
+
+```ruby
+analyzer.reflect(:name).simple_attribute?       # => true
+analyzer.reflect(:created_at).simple_attribute? # => true
+analyzer.reflect(:company_id).simple_attribute? # => false
+analyzer.reflect(:company).simple_attribute?    # => false
+analyzer.reflect(:accounts).simple_attribute?   # => false
+```
+
+### Associations
+
+An **Association** means foreign keys and association names.
+
+```ruby
+analyzer.reflect(:name).simple_attribute?       # => false
+analyzer.reflect(:created_at).simple_attribute? # => false
+analyzer.reflect(:company_id).simple_attribute? # => true
+analyzer.reflect(:company).simple_attribute?    # => true
+analyzer.reflect(:accounts).simple_attribute?   # => true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_record_analyzer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_record_analyzer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_analyzer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_analyzer"
+  spec.version       = ActiveRecordAnalyzer::VERSION
+  spec.authors       = ["Ariel Scherman"]
+  spec.email         = ["arielscherman@gmail.com"]
+
+  spec.summary       = %q{Analyze an ActiveRecord class to get information about its associations.}
+  spec.description   = %q{Analyze an ActiveRecord class to get information about its associations. You will be able to know all its has_many and belongs_to for instance.}
+  spec.homepage      = "https://github.com/arielscherman/active_record_analyzer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sqlite3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record_analyzer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record_analyzer/analyzer.rb

@@ -0,0 +1,5 @@
+class ActiveRecordAnalyzer::Analyzer
+  def initialize(klass)
+    ActiveRecordAnalyzer::Reflector.new(klass)
+  end
+end

data/lib/active_record_analyzer/attribute/association.rb

@@ -0,0 +1,9 @@
+class ActiveRecordAnalyzer::Attribute::Association
+  def association?
+    true
+  end
+
+  def simple_attribute?
+    false
+  end
+end

data/lib/active_record_analyzer/attribute/simple.rb

@@ -0,0 +1,9 @@
+class ActiveRecordAnalyzer::Attribute::Simple
+  def association?
+    false
+  end
+
+  def simple_attribute?
+    true
+  end
+end

data/lib/active_record_analyzer/attribute.rb

@@ -0,0 +1,2 @@
+class ActiveRecordAnalyzer::Attribute
+end

data/lib/active_record_analyzer/reflector/association.rb

@@ -0,0 +1,22 @@
+class ActiveRecordAnalyzer::Reflector::Association
+  def initialize(klass)
+    @klass = klass
+  end
+
+  def has_attribute?(attribute)
+    attributes.include?(attribute.to_sym)
+  end
+
+  def attribute_type
+    @attribute_type ||= ActiveRecordAnalyzer::Attribute::Association
+  end
+
+  # This returns foreign_keys and association names (ex: :company_id and :company).
+  def attributes
+    @attributes ||= begin
+      @klass.reflect_on_all_associations.map do |assoc|
+        [assoc.foreign_key.to_sym, assoc.name]
+      end.flatten
+    end
+  end
+end

data/lib/active_record_analyzer/reflector/simple.rb

@@ -0,0 +1,35 @@
+class ActiveRecordAnalyzer::Reflector::Simple
+  def initialize(klass)
+    @klass = klass
+  end
+
+  def has_attribute?(attribute)
+    attributes.include?(attribute.to_sym)
+  end
+
+  def attribute_type
+    @attribute_type ||= ActiveRecordAnalyzer::Attribute::Simple
+  end
+
+  # This returns attributes which are not foreign keys (ex: :name, but not :company_id)
+  #
+  def attributes
+    attributes_except_foreign_keys
+  end
+
+  private
+
+  def attributes_except_foreign_keys
+    @attributes ||= begin
+      all_attribute_names.select { |attr| !foreign_keys.include?(attr) }
+    end
+  end
+
+  def all_attribute_names
+    @all_attribute_names ||= @klass.attribute_names.map(&:to_sym)
+  end
+
+  def foreign_keys
+    @foreign_keys ||= ActiveRecordAnalyzer::Reflector::Association.new(@klass).attributes
+  end
+end

data/lib/active_record_analyzer/reflector.rb

@@ -0,0 +1,26 @@
+class ActiveRecordAnalyzer::Reflector
+  REFLECTORS = %i(association simple).freeze
+
+  def initialize(klass)
+    @klass = klass
+  end
+
+  # Asks every reflector if they find the given attribute in the class,
+  # and returns the attribute type (if any matched).
+  #
+  def reflect(attribute)
+    reflectors.find do |reflector|
+      reflector.has_attribute?(attribute)
+    end.try(:attribute_type)
+  end
+
+  def reflectors
+    REFLECTORS.map { |reflector_name| find_reflector(reflector_name).new(@klass) }
+  end
+
+  private
+
+  def find_reflector(reflector_name)
+    "ActiveRecordAnalyzer::Reflector::#{reflector_name.to_s.classify}".constantize
+  end
+end

data/lib/active_record_analyzer/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordAnalyzer
+  VERSION = "0.1.0"
+end

data/lib/active_record_analyzer.rb

@@ -0,0 +1,10 @@
+require "active_record_analyzer/version"
+require "active_record_analyzer/attribute"
+require "active_record_analyzer/attribute/simple"
+require "active_record_analyzer/reflector"
+require "active_record_analyzer/reflector/association"
+require "active_record_analyzer/reflector/simple"
+require "active_record_analyzer/analyzer"
+
+module ActiveRecordAnalyzer
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: active_record_analyzer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ariel Scherman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !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'
+- !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: Analyze an ActiveRecord class to get information about its associations.
+  You will be able to know all its has_many and belongs_to for instance.
+email:
+- arielscherman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_analyzer.gemspec
+- bin/console
+- bin/setup
+- lib/active_record_analyzer.rb
+- lib/active_record_analyzer/analyzer.rb
+- lib/active_record_analyzer/attribute.rb
+- lib/active_record_analyzer/attribute/association.rb
+- lib/active_record_analyzer/attribute/simple.rb
+- lib/active_record_analyzer/reflector.rb
+- lib/active_record_analyzer/reflector/association.rb
+- lib/active_record_analyzer/reflector/simple.rb
+- lib/active_record_analyzer/version.rb
+homepage: https://github.com/arielscherman/active_record_analyzer
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Analyze an ActiveRecord class to get information about its associations.
+test_files: []
+has_rdoc: