rails_stats 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc2b547901355a943a7d01f85c3b44e0d7669f49
-  data.tar.gz: c913a7bfabc5a2e6e4883288846ba0d4786697e0
+SHA256:
+  metadata.gz: 06f66a7f398a3206774d6dc5b80ce346e8c518f3469c386da5b23e2d4ebdc63e
+  data.tar.gz: a3628487b836738a60f55facfbb79d5617f641391e30ac0488e294a995b9332e
 SHA512:
-  metadata.gz: fe7e061a943858461c0cc8dc65d49213d8fdb2354db5ba25016eead9ae95f30fa5c6ed646f9bc55a3ee59a0bab14208629e41a70fe7cfad16994a8a44b08b26a
-  data.tar.gz: 52320637dea0bb648ba5ae8cb4c437274cc4ab7a6e5c76d9f0020a156ecab1b9503e808167168e1393debc08914566b3c745d81073171b381b5797fccfec1d48
+  metadata.gz: 03d2f39eeace55a4580f7222c1c50f53bfd2110459f69be3a976889d836f4477e7ba3d9e4969818270529a457a88c9929b2346cc81effc446a9c71a239ee9093
+  data.tar.gz: 75d02d452ef3f44b8a429bb80bd07e67bece730d5de1e60c25b4cd215a66deb8d7ebbe6134d305873856f1793488ba1bde41778204edc3e7a60515c3093c1474

data/.github/workflows/test.yml

@@ -0,0 +1,42 @@
+# .github/workflows/ci.yml
+
+name: Test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Uninstall existing Bundler
+        run: |
+          gem uninstall bundler -a -x || true
+      - name: Install Bundler
+        run: |
+          if [[ "${{ matrix.ruby-version }}" == "2.6" || "${{ matrix.ruby-version }}" == "2.7" ]]; then
+            gem install bundler -v "~> 2.4.0"
+          else
+            gem install bundler
+          fi
+      - name: Build and run tests
+        env:
+          COVERAGE: true
+          TERM: xterm
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: |
+          bundle install --jobs 4 --retry 3
+          bundle exec rake test

data/.gitignore

@@ -1,7 +1,9 @@
+.byebug_history
 *.gem
 *.rbc
 .bundle
 .config
+.ruby-version
 .yardoc
 Gemfile.lock
 InstalledFiles

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# main ([unreleased](https://github.com/fastruby/rails_stats/compare/v1.0.2...main))
+
+*
+
+# v2.0.0 ([commits](https://github.com/fastruby/rails_stats/compare/v1.0.2...v2.0.0))
+
+* [FEATURE: Add basic coverage to RailsStats::CodeStatistics#to_s](https://github.com/fastruby/rails_stats/pull/10)
+* [FEATURE: Enable simplecov and codecov](https://github.com/fastruby/rails_stats/pull/18)
+* [BUGFIX: Add methods for calculating M/C and LOC/M](https://github.com/fastruby/rails_stats/pull/19)
+* [FEATURE: Support JSON output](https://github.com/fastruby/rails_stats/pull/20)
+* [FEATURE: Add dependency on bundler-stats and improve output](https://github.com/fastruby/rails_stats/pull/21)
+* [FEATURE: Add files count to the console and JSON output](https://github.com/fastruby/rails_stats/pull/25)
+
+# v1.0.2 / 2020-10-7 ([commits](https://github.com/fastruby/rails_stats/compare/v1.0.1...v1.0.2))
+
+* [CHORE: Relax bundler dependency to make it easier to get started contributing](https://github.com/fastruby/rails_stats/pull/9)
+
+# v1.0.1 / 2018-10-8
+
+* [FEATURE: add more aggregate stats](https://github.com/fastruby/rails_stats/pull/5)
+* [FEATURE: More detailed introspection of app](https://github.com/fastruby/rails_stats/pull/1)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@ombulabs.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -1,4 +1,14 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in rails_stats.gemspec
 gemspec
+
+group :development, :test do
+  gem "bundler", ">= 1.6", "< 3.0"
+  gem "byebug"
+  gem "codecov"
+  gem "minitest"
+  gem "minitest-around"
+  gem "minitest-spec-context"
+  gem "simplecov"
+  gem "simplecov-console"
+end

data/README.md

@@ -3,13 +3,23 @@
 See stuff about a Rails app.
 
 There were a few things missing to the included `rake stats`
+
 RailsStats mainly adds the ability to be run from outside the project in question. This can be helpful if the app you are interested in can not be booted for some reason.
 
-### Run it
+### Run it outside Rails project
 
-```bash
+You will need a `Rakefile` in the directory where you call `rake` and you will
+need to require `rails_stats`:
+
+```ruby
+# Rakefile
+require "rails_stats"
+```
 
-$ bundle exec rake stats[/path/to/app/]
+Then you can call it:
+
+```bash
+$ rake stats\[/path/to/app/\]
 
 Directory: /path/to/app/
 
@@ -33,7 +43,12 @@ Directory: /path/to/app/
 | Total                | 21805 | 16980 |     218 |    1483 |   6 |     9 |
 +----------------------+-------+-------+---------+---------+-----+-------+
   Code LOC: 10142     Test LOC: 6838     Code to Test Ratio: 1:0.7
+```
 
+### Run it on many Rails engines
+
+```bash
+$ for dir in /path/to/many/engines/*/; do bundle exec rake stats[$dir]; done
 ```
 
 ### Within your Rails project
@@ -62,7 +77,7 @@ RailsStats adds more coverage than the default.
 
 ### Example output
 
-Here are some open source Rails projects an their output.
+Here are some open source Rails projects and their output.
 
 ```bash
 $ bundle exec rake stats[/users/brian/examples/diaspora/]
@@ -252,7 +267,35 @@ Directory: /users/brian/examples/spree
 | Total                | 56347 | 44503 |     341 |    2317 |   6 |    17 |
 +----------------------+-------+-------+---------+---------+-----+-------+
   Code LOC: 17870     Test LOC: 26633     Code to Test Ratio: 1:1.5
-  
+
+```
+
+#### JSON Format
+
+If you want to export the details using JSON, you can use this command:
+
+```
+$ rake stats\[test/dummy,json\]
+
+Directory: /Users/etagwerker/Projects/fastruby/rails_stats/test/dummy
+
+[{"name":"Mailers","lines":"4","loc":"4","classes":"1","methods":"0","m_over_c":"0","loc_over_m":"0"},{"name":"Models","lines":"3","loc":"3","classes":"1","methods":"0","m_over_c":"0","loc_over_m":"0"},{"name":"Javascripts","lines":"27","loc":"7","classes":"0","methods":"0","m_over_c":"0","loc_over_m":"0"},{"name":"Jobs","lines":"7","loc":"2","classes":"1","methods":"0","m_over_c":"0","loc_over_m":"0"},{"name":"Controllers","lines":"7","loc":"6","classes":"1","methods":"1","m_over_c":"1","loc_over_m":"4"},{"name":"Helpers","lines":"3","loc":"3","classes":"0","methods":"0","m_over_c":"0","loc_over_m":"0"},{"name":"Channels","lines":"8","loc":"8","classes":"2","methods":"0","m_over_c":"0","loc_over_m":"0"},{"name":"Configuration","lines":"417","loc":"111","classes":"1","methods":"0","m_over_c":"0","loc_over_m":"0"},{"name":"Total","lines":"476","loc":"144","classes":"7","methods":"1","m_over_c":"0","loc_over_m":"142","code_to_test_ratio":"0.0","total":true}]
+```
+
+### Testing
+
+In order to run the tests for this gem:
+
+```bash
+bundle exec rake
+
+# Running:
+
+.
+
+Fabulous run in 0.013349s, 74.9120 runs/s, 74.9120 assertions/s.
+
+1 runs, 1 assertions, 0 failures, 0 errors, 0 skips
 ```
 
 ### TODO

data/Rakefile

@@ -1 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
 require "rails_stats"
+
+Rake::TestTask.new do |task|
+  task.libs.push "lib"
+  task.libs.push "test"
+  task.pattern = "test/**/*_test.rb"
+end
+
+task default: %i[test]

data/codecov.yml

@@ -0,0 +1,2 @@
+codecov:
+  token: d7028c0e-97c5-485f-85e5-f63daabeef63

data/lib/rails_stats/all.rb

@@ -1,3 +1,7 @@
+require 'rails_stats/stats_calculator'
+require 'rails_stats/stats_formatter'
+require 'rails_stats/json_formatter'
+require 'rails_stats/console_formatter'
 require 'rails_stats/inflector'
 require 'rails_stats/code_statistics_calculator'
 require 'rails_stats/util'

data/lib/rails_stats/app_statistics.rb

@@ -3,10 +3,11 @@ module RailsStats
     attr_reader :statistics, :total, :test
 
     def initialize(directory)
+      @directories = []
       @test = false
-      @directory  = directory
-      @statistics = calculate_statistics
-      @total      = calculate_total
+      @directory   = directory
+      @statistics  = calculate_statistics
+      @total       = calculate_total
     end
 
     def key_concepts
@@ -28,15 +29,15 @@ module RailsStats
     end
 
     def directories
-      return @directories if @directories
-      out = []
+      return @directories if @directories.any?
+
       Dir.foreach(@directory) do |file_name|
         path = File.join(@directory, file_name)
         next unless File.directory?(path)
         next if (/^\./ =~ file_name)
         next if file_name == "assets" # doing separately
         next if file_name == "views"  # TODO
-        out << path
+        @directories << path
       end
 
       assets = File.join(@directory, "assets")
@@ -48,13 +49,13 @@ module RailsStats
 
           case file_name
           when "javascripts"
-            out << path
+            @directories << path
           # TODO when "css"
           end
         end
       end
 
-      out
+      @directories
     end
   end
 

data/lib/rails_stats/code_statistics.rb

@@ -2,162 +2,23 @@
 
 module RailsStats
   class CodeStatistics
-
-    RAILS_APP_FOLDERS = ['models',
-                         'controllers',
-                         'helpers',
-                         'mailers',
-                         'views',
-                         'assets']
-
-    def initialize(root_directory)
-      @root_directory = root_directory
-      @key_concepts   = calculate_key_concepts
-      @projects       = calculate_projects
-      @statistics     = calculate_statistics
-      @total          = calculate_total
+    def initialize(root_directory, opts = {})
+      @calculator     = RailsStats::StatsCalculator.new(root_directory)
+      @formatter      = load_formatter(opts)
     end
 
     def to_s
-      print_header
-      @statistics.each { |key, stats| print_line(key, stats) }
-      print_splitter
-
-      if @total
-        print_line("Total", @total)
-        print_splitter
-      end
-
-      print_code_test_stats
+      @formatter.to_s
     end
 
     private
-      def calculate_key_concepts
-        # returns names of main things like models, controllers, services, etc
-        concepts = {}
-        app_projects.each do |project|
-          project.key_concepts.each do |key|
-            concepts[key] = true
-          end
-        end
-
-        # TODO: maybe gem names?
-
-        concepts.keys
-      end
-
-      def calculate_projects
-        out = []
-        out += app_projects
-        out += calculate_root_projects
-        out += calculate_gem_projects
-        out += calculate_spec_projects
-        out += calculate_test_projects
-        out += calculate_cucumber_projects
-        out
-      end
-
-      def app_projects
-        @app_projects ||= calculate_app_projects
-      end
-
-      def calculate_app_projects
-        apps = Util.calculate_projects(@root_directory, "**", "app", RAILS_APP_FOLDERS)
-        apps.collect do |root_path|
-          AppStatistics.new(root_path)
-        end
-      end
-
-      def calculate_gem_projects
-        gems = Util.calculate_projects(@root_directory, "*", "**", "*.gemspec")
-        gems.collect do |root_path|
-          GemStatistics.new(root_path)
-        end
-      end
-
-      def calculate_spec_projects
-        specs = Util.calculate_shared_projects("spec", @root_directory, "**", "spec", "**", "*_spec.rb")
-        specs.collect do |root_path|
-          SpecStatistics.new(root_path, @key_concepts)
-        end
-      end
 
-      def calculate_test_projects
-        tests = Util.calculate_shared_projects("test", @root_directory, "**", "test", "**", "*_test.rb")
-        tests.collect do |root_path|
-          TestStatistics.new(root_path, @key_concepts)
+      def load_formatter(opts = {})
+        if opts[:format] == "json"
+          RailsStats::JSONFormatter.new(@calculator, opts)
+        else
+          RailsStats::ConsoleFormatter.new(@calculator, opts)
         end
       end
-
-      def calculate_root_projects
-        [RootStatistics.new(@root_directory)]
-      end
-
-      def calculate_cucumber_projects
-        cukes = Util.calculate_projects(@root_directory, "**", "*.feature")
-        cukes.collect do |root_path|
-          CucumberStatistics.new(root_path)
-        end
-      end
-
-      def calculate_statistics
-        out = {}
-        @projects.each do |project|
-          project.statistics.each do |key, stats|
-            out[key] ||= CodeStatisticsCalculator.new(project.test)
-            out[key].add(stats)
-          end
-        end
-        out
-      end
-
-      def calculate_total
-        @statistics.each_with_object(CodeStatisticsCalculator.new) do |pair, total|
-          total.add(pair.last)
-        end
-      end
-
-      def calculate_code
-        code_loc = 0
-        @statistics.each { |k, v| code_loc += v.code_lines unless v.test }
-        code_loc
-      end
-
-      def calculate_tests
-        test_loc = 0
-        @statistics.each { |k, v| test_loc += v.code_lines if v.test }
-        test_loc
-      end
-
-      def print_header
-        print_splitter
-        puts "| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |"
-        print_splitter
-      end
-
-      def print_splitter
-        puts "+----------------------+-------+-------+---------+---------+-----+-------+"
-      end
-
-      def print_line(name, statistics)
-        m_over_c   = (statistics.methods / statistics.classes) rescue m_over_c = 0
-        loc_over_m = (statistics.code_lines / statistics.methods) - 2 rescue loc_over_m = 0
-
-        puts "| #{name.ljust(20)} " \
-             "| #{statistics.lines.to_s.rjust(5)} " \
-             "| #{statistics.code_lines.to_s.rjust(5)} " \
-             "| #{statistics.classes.to_s.rjust(7)} " \
-             "| #{statistics.methods.to_s.rjust(7)} " \
-             "| #{m_over_c.to_s.rjust(3)} " \
-             "| #{loc_over_m.to_s.rjust(5)} |"
-      end
-
-      def print_code_test_stats
-        code  = calculate_code
-        tests = calculate_tests
-
-        puts "  Code LOC: #{code}     Test LOC: #{tests}     Code to Test Ratio: 1:#{sprintf("%.1f", tests.to_f/code)}"
-        puts ""
-      end
   end
 end

data/lib/rails_stats/code_statistics_calculator.rb

@@ -2,7 +2,7 @@
 
 module RailsStats
   class CodeStatisticsCalculator #:nodoc:
-    attr_reader :lines, :code_lines, :classes, :methods, :test
+    attr_reader :files_total, :lines, :code_lines, :classes, :methods, :test
 
     PATTERNS = {
       rb: {
@@ -33,6 +33,7 @@ module RailsStats
 
     def initialize(test=false)
       @test = test
+      @files_total = 0
       @lines = 0
       @code_lines = 0
       @classes = 0
@@ -40,6 +41,7 @@ module RailsStats
     end
 
     def add(code_statistics_calculator)
+      @files_total += code_statistics_calculator.files_total
       @lines += code_statistics_calculator.lines
       @code_lines += code_statistics_calculator.code_lines
       @classes += code_statistics_calculator.classes
@@ -47,6 +49,8 @@ module RailsStats
     end
 
     def add_by_file_path(file_path)
+      @files_total += 1
+
       File.open(file_path) do |f|
         self.add_by_io(f, file_type(file_path))
       end

data/lib/rails_stats/console_formatter.rb

@@ -0,0 +1,59 @@
+require "bundler/stats/cli"
+
+module RailsStats
+  class ConsoleFormatter < StatsFormatter
+    def to_s
+      Bundler::Stats::CLI.start
+
+      print_header
+      sorted_keys = @statistics.keys.sort
+      sorted_keys.each { |key| print_line(key, @statistics[key]) }
+      print_splitter
+
+      if @grand_total
+        print_line("Code", @code_total)
+        print_line("Tests", @tests_total)
+        print_line("Total", @grand_total)
+        print_splitter
+      end
+
+      print_code_test_stats
+    end
+
+    private
+
+      def print_header
+        print_splitter
+        puts "| Name                 | Files   | Lines   |     LOC | Classes | Methods | M/C | LOC/M |"
+        print_splitter
+      end
+
+      def print_splitter
+        puts "+----------------------+---------+---------+---------+---------+---------+-----+-------+"
+      end
+
+      def print_line(name, statistics)
+        m_over_c   = (statistics.methods / statistics.classes) rescue m_over_c = 0
+        loc_over_m = (statistics.code_lines / statistics.methods) - 2 rescue loc_over_m = 0
+
+        require 'byebug'; byebug if statistics.nil?
+
+        puts "| #{name.ljust(20)} " \
+            "| #{statistics.files_total.to_s.rjust(7)} " \
+            "| #{statistics.lines.to_s.rjust(7)} " \
+            "| #{statistics.code_lines.to_s.rjust(7)} " \
+            "| #{statistics.classes.to_s.rjust(7)} " \
+            "| #{statistics.methods.to_s.rjust(7)} " \
+            "| #{m_over_c.to_s.rjust(3)} " \
+            "| #{loc_over_m.to_s.rjust(5)} |"
+      end
+
+      def print_code_test_stats
+        code  = calculator.code_loc
+        tests = calculator.test_loc
+
+        puts "  Code LOC: #{code}     Test LOC: #{tests}     Code to Test Ratio: 1:#{sprintf("%.1f", tests.to_f/code)}  Files: #{calculator.files_total}"
+        puts ""
+      end
+  end
+end

data/lib/rails_stats/json_formatter.rb

@@ -0,0 +1,46 @@
+require "json"
+
+module RailsStats
+  class JSONFormatter < StatsFormatter
+    def result
+      @result = @statistics.map { |key, stats| stat_hash(key, stats) }
+
+      if @grand_total
+        @result << stat_hash("Total", @grand_total).merge(code_test_hash)
+      end
+
+      @result
+    end
+
+    def to_s
+      puts result.to_json
+    end
+
+    private
+
+      def code_test_hash
+        code  = calculator.code_loc
+        tests = calculator.test_loc
+
+        {
+          "code_to_test_ratio" => "#{sprintf("%.1f", tests.to_f/code)}", "total" => true
+        }
+      end
+
+      def stat_hash(name, statistics)
+        m_over_c   = (statistics.methods / statistics.classes) rescue m_over_c = 0
+        loc_over_m = (statistics.code_lines / statistics.methods) - 2 rescue loc_over_m = 0
+
+        {
+          "name" => name,
+          "files" => statistics.files_total.to_s,
+          "lines" => statistics.lines.to_s,
+          "loc" => statistics.code_lines.to_s,
+          "classes" => statistics.classes.to_s,
+          "methods" => statistics.methods.to_s,
+          "m_over_c" => m_over_c.to_s,
+          "loc_over_m" => loc_over_m.to_s
+        }
+      end
+  end
+end

data/lib/rails_stats/spec_statistics.rb

@@ -37,7 +37,7 @@ module RailsStats
       out = {}
       categorize_files.each do |key, list|
         out[key] = Util.calculate_file_statistics(list)
-      end 
+      end
       out
     end