trains 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5413c3e6b18ce996f955e2ad43eaddb7fc13d67ead0eab3ed79fdc09820c7fc9
-  data.tar.gz: 1c8f46daedfc9115f35baa7ab70d8c987145e67e2f02c51906cd9a1af012c2be
+  metadata.gz: 5967b89c0edf52539f69630d235c4e32b0a14a34e2739f593ca666e6ea451e02
+  data.tar.gz: 95ef423ff42e64a346931ce84d1becd8d810fcb92b52e51bf9f628d84821e273
 SHA512:
-  metadata.gz: 0cdd205741e22ff8cacf3f4bf590faac07cba5eb6d3dae8126da6f13cefbb65ce556734e3484f70183777c3b9dea617e3fe0c2cc953bc1b380a975ba78dbf983
-  data.tar.gz: 31c57301eb2fa078d067f7685380ca981d2cf16c724d54fc0deed63e52836f1fbc66a3813b11756d243203133bc33c9eb33052c77329732fa5ea00df3f8d797f
+  metadata.gz: 32e6e039363c647c6175a770636d4082edc081f525d8dba56628d47e1cf55e56218ca0b6b39969b9cf64b50e6216fcdcc5dc589d0abfeeffc01f224afc9b3aaa
+  data.tar.gz: 5de86fe0d626f302865a2b9b6b8d4c41ea6fbf9ff20ddc7057ef06a71cca1324af3c226a016339eb78d8bc8da5c7c7a914d5e7828d8ca6b0965daf3537db8e15

data/CHANGELOG.md

@@ -1,5 +1,14 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2023-02-19
+All notable changes to this project will be documented in this file.
 
-- Initial release
+## [0.0.2] - 2023-02-19
+
+- Add `bin/setup` and `bin/console` for development convenience
+
+## [0.0.1] - 2023-02-19
+
+- Add AST visitors for controllers and models
+- Controller visitor returns `DTO::Controller`
+- Migration visitor returns `DTO::Model`
+- `Scanner` class is the main interface of the gem

data/Gemfile

@@ -6,6 +6,7 @@ gem 'rubocop-ast'
 gem 'zeitwerk', '~> 2.5'
 
 group :test, :development do
+  gem 'rake', '~> 13.0'
   gem 'rspec', '~> 3.12'
   gem 'ruby-lsp', '~> 0.3.7', require: false
 end

data/Gemfile.lock

@@ -17,6 +17,7 @@ GEM
     parser (3.1.1.0)
       ast (~> 2.4.1)
     prettier_print (1.2.0)
+    rake (13.0.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -49,6 +50,7 @@ PLATFORMS
 DEPENDENCIES
   activesupport (~> 7.0)
   parallel (~> 1.22)
+  rake (~> 13.0)
   rspec (~> 3.12)
   rubocop-ast
   ruby-lsp (~> 0.3.7)

data/README.md

@@ -2,6 +2,21 @@
 
 A gem that statically analyses your Rails app and extracts information about its structure.
 
+[![DeepSource](https://deepsource.io/gh/faraazahmad/trains.svg/?label=active+issues&show_trend=true&token=RKfXNZL_RQe6j2NEhXv2iOeh)](https://deepsource.io/gh/faraazahmad/trains/?ref=repository-badge)
+[![DeepSource](https://deepsource.io/gh/faraazahmad/trains.svg/?label=resolved+issues&show_trend=true&token=RKfXNZL_RQe6j2NEhXv2iOeh)](https://deepsource.io/gh/faraazahmad/trains/?ref=repository-badge)
+
+## Index
+
+1. [Installation](#installation)
+2. [Usage](#usage)
+3. [Features](#features)
+    3.1 [Create Model definitions from migrations](#create-model-definitions-from-migrations)
+    3.2 [Create controller definitions from files](#create-controller-definitions-from-files)
+4. [Development](#development)
+5. [Contributing](#contributing)
+6. [License](#license)
+7. [Code of conduct](#code-of-conduct)
+
 ## Installation
 
 Install the gem and add it to the application's Gemfile by executing:
@@ -48,10 +63,10 @@ Trains will generate the following Model definition:
 Trains::DTO::Model(
   name: 'Group',
   fields:
-    Set[
-      Trains::DTO::Field(:datetime, :created_at),
-      Trains::DTO::Field(:datetime, :updated_at),
-      Trains::DTO::Field(:string, :title)
+    [
+      Trains::DTO::Field(:title, :string),
+      Trains::DTO::Field(:created_at, :datetime),
+      Trains::DTO::Field(:updated_at, :datetime),
     ],
   version: 7.0
 )
@@ -77,8 +92,13 @@ Trains will return the following controller definition:
 
 ```ruby
 Trains::DTO::Controller(
-  name: 'BoxController',
-  methods: Set[:create, :edit, :update, :destroy]
+    name: 'BoxController',
+    method_list: [
+      Trains::DTO::Method(name: 'create', visibility: nil, source: nil),
+      Trains::DTO::Method(name: 'edit', visibility: nil, source: nil),
+      Trains::DTO::Method(name: 'update', visibility: nil, source: nil),
+      Trains::DTO::Method(name: 'destroy', visibility: nil, source: nil)
+    ]
 )
 ```
 
@@ -90,7 +110,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/trains. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/trains/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/faraazahmad/trains. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/faraazahmad/trains/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -98,5 +118,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Trains project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/trains/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Trains project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/faraazahmad/trains/blob/master/CODE_OF_CONDUCT.md).
 

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/lib/trains/version.rb

@@ -0,0 +1,3 @@
+module Trains
+  VERSION = '0.0.3'
+end

data/lib/trains/visitor/migration.rb

@@ -19,7 +19,9 @@ module Trains
       end
 
       def on_class(node)
-        return unless node.parent_class.source.include? 'ActiveRecord::Migration'
+        unless node.parent_class.source.include? 'ActiveRecord::Migration'
+          return
+        end
 
         @migration_class = node.children.first.source
         @migration_version = extract_version(node.parent_class.source)

data/lib/trains.rb

@@ -1,6 +1,5 @@
 require 'yaml'
 require 'rubocop-ast'
-require 'fast_ignore'
 require 'zeitwerk'
 require 'active_support/core_ext/string/inflections'
 require 'parallel'

data/trains.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/trains/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'trains'
+  spec.version = Trains::VERSION
+  spec.authors = ['Syed Faraaz Ahmad']
+  spec.email = ['faraaz98@live.com']
+
+  spec.summary =
+    'Collect metadata about your Rails app by statically analyzing it'
+  spec.homepage = 'https://github.com/faraazahmad/trains'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "https://github.com/faraazahmad/trains/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(__dir__) do
+      `git ls-files -z`.split("\x0")
+                       .reject do |f|
+        (f == __FILE__) ||
+          f.match(
+            %r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)}
+          )
+      end
+    end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 7.0'
+  spec.add_dependency 'parallel', '~> 1.22'
+  spec.add_dependency 'rubocop-ast', '~> 1.16'
+  spec.add_dependency 'zeitwerk', '~> 2.5'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trains
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Syed Faraaz Ahmad
@@ -83,6 +83,7 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- Rakefile
 - lib/trains.rb
 - lib/trains/dto/app.rb
 - lib/trains/dto/controller.rb
@@ -94,10 +95,12 @@ files:
 - lib/trains/utils/logger.rb
 - lib/trains/utils/rails_dir.rb
 - lib/trains/utils/result.rb
+- lib/trains/version.rb
 - lib/trains/visitor/base.rb
 - lib/trains/visitor/controller.rb
 - lib/trains/visitor/helper.rb
 - lib/trains/visitor/migration.rb
+- trains.gemspec
 homepage: https://github.com/faraazahmad/trains
 licenses:
 - MIT