trains 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7edd36bbbc3349d7b32a1719cb5e80038953853e18d5d927ab2e713b621f356f
-  data.tar.gz: 97c661e09da45575d54fca505ab1a967b941c0bca806e29a1155739ca387f1a4
+  metadata.gz: 2b1af8d7a53681c21f561432534383da1d83bf4615bc8e85bdfa6c8ce7b210aa
+  data.tar.gz: aa4798c33b271c590c5b966078eb7a6f9fd603a069842ce454cadb14de8cc08d
 SHA512:
-  metadata.gz: f560a4e5f4adf6fb45238f4deb1fcc3bb4dbcbf8a7a5b5dec7c74ff27224dd6a7afa00fe4702c1fa939626f8200a88b5d0383615967a3cd46af0d64cb6ae4b17
-  data.tar.gz: e3ae6062e8aea943fdb3d030c962edfdb23b631d60f33d17a1a9a041ad05fdb78424d427668dd76e015aa22564a0d2e18ee2dba2c9138445a9870040cfb75209
+  metadata.gz: f6faddb254499e05f02a13def98dc7ab1f7df69d2ff694617cbd24410e2cb23266c7fd4c067cb2e4e2dd4fd7e7552f7d5ba79c995f2f951ff452150b8d800222
+  data.tar.gz: 95748dab8e2f16aed324d9c55a8d14c0eeec265361d49794bf7d81f21f6b42b8a25ba7426f719fea673efc982864ff49c745d3cdeb6888780b63a3bdf81038b9

data/lib/trains/dto/app.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Trains
   module DTO
     App =
-      Data.define(:name, :controllers, :models, :migrations, :helpers, :routes)
+      Data.define(:name, :controllers, :models, :helpers, :routes)
   end
 end

data/lib/trains/dto/callback.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Trains
+  module DTO
+    Callback = Data.define(:method, :arguments)
+  end
+end

data/lib/trains/dto/controller.rb

@@ -2,6 +2,6 @@ require "set"
 
 module Trains
   module DTO
-    Controller = Data.define(:name, :method_list)
+    Controller = Data.define(:name, :method_list, :callbacks)
   end
 end

data/lib/trains/dto/migration.rb

@@ -0,0 +1,5 @@
+module Trains
+  module DTO
+    Migration = Data.define(:table_name, :modifier, :fields, :version)
+  end
+end

data/lib/trains/scanner.rb

@@ -5,10 +5,9 @@ module Trains
 
     def initialize(folder, options = {})
       @root_folder = folder
-      @nodes = []
-      @models = []
-      @controllers = []
-      @helpers = []
+      @models = {}
+      @controllers = {}
+      @helpers = {}
       @dir = File.expand_path(folder)
       @options = options
     end
@@ -23,15 +22,13 @@ module Trains
         return(
           Result.new(
             data: nil,
-            error: ArgumentError.new("Not a Rails directory")
+            error: ArgumentError.new('Not a Rails directory')
           )
         )
       end
 
-      @models = get_models.to_set unless @options[:models] == false
-      @migrations = get_migrations.to_set unless @options[:migrations] == false
-      @controllers = get_controllers.to_set unless @options[:controllers] ==
-        false
+      @models = generate_models unless @options[:models] == false
+      @controllers = get_controllers unless @options[:controllers] == false
       @routes = get_routes.to_set unless @options[:routes] == false
       # TODO: @helpers = get_helpers
 
@@ -40,7 +37,6 @@ module Trains
         name: nil,
         controllers: @controllers,
         models: @models,
-        migrations: @migrations,
         helpers: @helpers,
         routes: @routes
       )
@@ -48,51 +44,65 @@ module Trains
 
     private
 
+    # Generate models from either db/schema.rb
+    # else stitch together migrations to create models
+    def generate_models
+      return get_models if File.exist?(File.join(@dir, 'db', 'schema.rb'))
+
+      migrations = get_migrations
+      Utils::MigrationTailor.stitch(migrations)
+    end
+
     def get_routes
-      route_file = [File.join(@dir, "config", "routes.rb")]
+      route_file = [File.join(@dir, 'config', 'routes.rb')]
 
       routes_results = parse_util(route_file, Visitor::Route)
       routes_results
         .select { |result| result.error.nil? }
-        .map { |result| result.data }
+        .map(&:data)
         .flatten
     end
 
     def get_models
-      schema_file = [File.join(@dir, "db", "schema.rb")]
-      return unless File.exist?(schema_file.first)
-
+      result_hash = {}
+      schema_file = [File.join(@dir, 'db', 'schema.rb')]
       models_results = parse_util(schema_file, Visitor::Schema)
+
       models_results
         .select { |result| result.error.nil? }
-        .map { |result| result.data }
+        .map(&:data)
         .flatten
-    end
+        .each { |model| result_hash[model.name] = model }
 
-    def get_helpers
+      result_hash
     end
 
-    def get_gemfile
-    end
+    def get_helpers; end
+
+    def get_gemfile; end
 
     def get_controllers
+      result_hash = {}
       controllers =
-        Dir.glob(File.join(@dir, "app", "controllers", "**", "*_controller.rb"))
-
+        Dir.glob(File.join(@dir, 'app', 'controllers', '**', '*_controller.rb'))
       controller_results = parse_util(controllers, Visitor::Controller)
+
       controller_results
         .select { |result| result.error.nil? }
-        .map { |result| result.data }
+        .map(&:data)
         .flatten
+        .each { |controller| result_hash[controller.name] = controller }
+
+      result_hash
     end
 
     def get_migrations
-      migrations = Dir.glob(File.join(@dir, "db", "migrate", "**", "*.rb"))
-
+      migrations = Dir.glob(File.join(@dir, 'db', 'migrate', '**', '*.rb'))
       migration_results = parse_util(migrations, Visitor::Migration)
+
       migration_results
         .select { |result| result.error.nil? }
-        .map { |result| result.data }
+        .map(&:data)
     end
 
     def parse_util(file_nodes, visitor_class)
@@ -109,42 +119,21 @@ module Trains
       end
 
       Parallel.map(file_nodes) do |node|
-        begin
-          processed_source =
-            RuboCop::AST::ProcessedSource.from_file(node, RUBY_VERSION.to_f)
-          visitor = visitor_class.new
-          visitor.process(processed_source.ast)
-
-          Result.new(data: visitor.result, error: nil)
-        rescue StandardError => e
-          puts "An error occurred while parsing #{node}. Use debug option to view backtrace. Skipping file..."
-          puts e.backtrace if @options[:debug]
-
-          Result.new(data: nil, error: e)
+        processed_source =
+          RuboCop::AST::ProcessedSource.from_file(node, RUBY_VERSION.to_f)
+        visitor = visitor_class.new
+        visitor.process(processed_source.ast)
+
+        Result.new(data: visitor.result, error: nil)
+      rescue StandardError => e
+        puts "An error occurred while parsing #{node}. Use debug option to view backtrace. Skipping file..."
+        if @options[:debug]
+          puts e.message
+          puts e.backtrace
         end
-      end
-    end
 
-    def get_tree(node, prefix = "")
-      path = File.join(prefix, node)
-      obj = { path: nil }
-
-      # puts "DEBUG: #{path} #{ FastIgnore.new.allowed? path }"
-      if path != @dir.to_path &&
-           FastIgnore.new.allowed?(path, directory: false) == false
-        return nil
+        Result.new(data: nil, error: e)
       end
-
-      if Dir.exist? path
-        children = []
-        Dir.each_child path do |child|
-          child_node = get_tree(child, path)
-          children.append(child_node) unless child_node.nil?
-        end
-        obj[:children] = children
-      end
-
-      obj
     end
   end
 end

data/lib/trains/utils/args.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Trains
+  module Utils
+    # utility module to deal with parsing of arguments
+    module Args
+      def parse_args(node)
+        case node.type
+        when :hash
+          parse_hash(node)
+        else
+          parse_value(node)
+        end
+      end
+
+      def parse_hash(node)
+        options = {}
+        return options unless node.type == :hash
+
+        node.each_pair { |key, value| options[key.value] = parse_value(value) }
+      rescue StandardError => e
+        puts node.parent
+      ensure
+        return options
+      end
+
+      def parse_value(node)
+        case node.type
+        when :hash
+          parse_hash(node)
+        when :array
+          node.values.map { |value| parse_value(value) }
+        when :send
+          if node.method_name == :redirect
+            { redirect: node.arguments.first.value }
+          end
+        else
+          node.value
+        end
+      end
+    end
+  end
+end

data/lib/trains/utils/migration_tailor.rb

@@ -0,0 +1,43 @@
+module Trains
+  module Utils
+    module MigrationTailor
+      def self.stitch(migrations)
+        models = {}
+
+        migrations.each do |mig|
+          case mig.modifier
+          when :create_table
+            models[mig.table_name] = {}
+            models[mig.table_name] = Trains::DTO::Model.new(
+              name: mig.table_name,
+              fields: mig.fields,
+              version: mig.version
+            )
+          when :add_column
+            models[mig.table_name].fields.push(*mig.fields)
+          when :remove_column
+            column =
+              models[mig.table_name].fields.find do |field|
+                field.name == mig.fields.first.name
+              end
+            models[mig.table_name].fields.delete(column)
+          when :change_table
+          # TODO: handle renaming columns
+          when :change_column
+            # get column
+            column =
+              models[mig.table_name].fields.find do |field|
+                field.name == mig.fields.first.name
+              end
+            # replace it with new column object
+            models[mig.table_name].fields.delete(column)
+
+            models[mig.table_name].fields << mig.fields.first
+          end
+        end
+
+        models
+      end
+    end
+  end
+end

data/lib/trains/version.rb

@@ -1,3 +1,3 @@
 module Trains
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 end

data/lib/trains/visitor/controller.rb

@@ -1,14 +1,24 @@
-require_relative "../dto/controller"
-require_relative "../dto/method"
+# frozen_string_literal: true
+
+require_relative '../dto/callback'
+require_relative '../dto/controller'
+require_relative '../dto/method'
 
 module Trains
   module Visitor
     # Visitor that parses controllers and returns a DTO::Controller object
     class Controller < Base
+      include Utils::Args
+
+      TRACKED_CALLBACKS = [
+        :http_basic_authenticate_with
+      ].freeze
+
       def initialize
         @method_list = []
         @methods = {}
         @class_name = nil
+        @callbacks = []
       end
 
       def on_class(node)
@@ -17,15 +27,25 @@ module Trains
         return unless controller?(parent_class)
 
         @class_name = class_name
+        find_callbacks(node)
         parse_body(node.body) unless node.body.nil?
       end
 
       def result
-        DTO::Controller.new(name: @class_name, method_list: @method_list.uniq)
+        DTO::Controller.new(name: @class_name, method_list: @method_list.uniq, callbacks: @callbacks)
       end
 
       private
 
+      def find_callbacks(klass_node)
+        klass_node.each_descendant(:send) do |node|
+          if node.receiver.nil? && TRACKED_CALLBACKS.include?(node.method_name)
+            @callbacks << DTO::Callback.new(method: node.method_name,
+                                            arguments: node.arguments.map { |arg| parse_args(arg) })
+          end
+        end
+      end
+
       def parse_body(body)
         body.each_child_node do |child|
           @method_list << parse_method(child) if child.type == :def

data/lib/trains/visitor/migration.rb

@@ -9,6 +9,7 @@ module Trains
 
       def initialize
         @model = nil
+        @table_modifier = nil
         @table_name = nil
         @is_class = false
         @is_migration = false
@@ -30,7 +31,12 @@ module Trains
       end
 
       def result
-        DTO::Model.new(@table_name, @fields, @migration_version)
+        DTO::Migration.new(
+          table_name: @table_name,
+          modifier: @table_modifier,
+          fields: @fields,
+          version: @migration_version
+        )
       end
 
       private
@@ -50,11 +56,19 @@ module Trains
 
       def process_def_node(node)
         allowed_method_names = %i[change up down]
-        allowed_table_modifiers = %i[create_table update_column add_column]
+        allowed_table_modifiers = %i[
+          create_table
+          change_table
+          update_column
+          add_column
+          remove_column
+          change_column
+        ]
         block_type_modifier = false
 
         method_name = node.method_name
         return unless allowed_method_names.include? method_name
+        return if node.body.nil?
 
         table_modifier =
           if node.body.children[0] == nil
@@ -68,6 +82,8 @@ module Trains
           end
         return unless allowed_table_modifiers.include? table_modifier
 
+        @table_modifier = table_modifier
+
         # Get the name of the table being modified
         if block_type_modifier
           raw_table_name =
@@ -81,8 +97,8 @@ module Trains
           raw_table_name = node.body.children[2].value.to_s
           @table_name = raw_table_name.singularize.camelize
 
-          field_name = node.body.children[3].value
-          field_type = node.body.children[4].value
+          field_name = node.body.children[3]&.value
+          field_type = node.body.children[4]&.value
           @fields.append(DTO::Field.new(field_name, field_type))
         end
       end
@@ -95,7 +111,7 @@ module Trains
           @fields.append(DTO::Field.new(:updated_at, :datetime))
           return
         end
-        
+
         type = node.children[1]
         value = node.children[2].value unless node.children[2].hash_type?
         @fields.append(DTO::Field.new(value, type))

data/lib/trains/visitor/route.rb

@@ -1,8 +1,11 @@
-require_relative "../dto/route"
+require_relative '../dto/route'
 
 module Trains
   module Visitor
+    # Visitor for Parsing Rails routes
     class Route < Base
+      include Utils::Args
+
       def_node_matcher :route_parent?, <<~PATTERN
         (block (send (send (send
           (const nil? :Rails) :application) :routes) :draw)
@@ -13,7 +16,7 @@ module Trains
         (send nil? %1 ...)
       PATTERN
 
-      ALLOWED_VERBS = %i[get put post update delete resources scope]
+      ALLOWED_VERBS = %i[get put post update delete resources scope].freeze
 
       def initialize
         @route_list = []
@@ -25,6 +28,7 @@ module Trains
 
       def on_block(node)
         return unless route_parent?(node)
+        return if node.body.nil?
 
         node.body.each_child_node do |child|
           ALLOWED_VERBS.each do |verb|
@@ -45,33 +49,7 @@ module Trains
             node.arguments[0].value
           end
         options = parse_hash(node.arguments[1])
-        DTO::Route.new(method: method, param: param, options: options)
-      end
-
-      def parse_hash(node)
-        options = {}
-        return options unless node.type == :hash
-
-        node.each_pair { |key, value| options[key.value] = parse_value(value) }
-      rescue StandardError => e
-        puts node.parent
-      ensure
-        return options
-      end
-
-      def parse_value(node)
-        case node.type
-        when :hash
-          parse_hash(node)
-        when :array
-          node.values.map { |value| parse_value(value) }
-        when :send
-          if node.method_name == :redirect
-            { redirect: node.arguments.first.value }
-          end
-        else
-          node.value
-        end
+        DTO::Route.new(method:, param:, options:)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trains
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Syed Faraaz Ahmad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -85,13 +85,17 @@ files:
 - Rakefile
 - lib/trains.rb
 - lib/trains/dto/app.rb
+- lib/trains/dto/callback.rb
 - lib/trains/dto/controller.rb
 - lib/trains/dto/field.rb
 - lib/trains/dto/method.rb
+- lib/trains/dto/migration.rb
 - lib/trains/dto/model.rb
 - lib/trains/dto/route.rb
 - lib/trains/scanner.rb
+- lib/trains/utils/args.rb
 - lib/trains/utils/logger.rb
+- lib/trains/utils/migration_tailor.rb
 - lib/trains/utils/rails_dir.rb
 - lib/trains/utils/result.rb
 - lib/trains/version.rb