nova_git_stats 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6c4a94033fd555ab2caa45a9aba91f3e8b60109008ba3a8fba8f639c24a81a1
-  data.tar.gz: f7fc62f9a5c725934a40b746a3ad816e0aad5a91e98e78b42558157abc55faed
+  metadata.gz: d9c75ae01414c7ec2ecd2a0ba1f1e94bc042f0b40d59ff46d9fae171686ee0d6
+  data.tar.gz: 50c677c1d4f8434f9c0a5ae87f58fcac8bde933b88a09171b27e880b375e8657
 SHA512:
-  metadata.gz: aa8462b76ef85e84d9b7ac825d7cbeff3876f2f81c670a074af55e3f5e3737412542babca988e7b6404a28916ac04b7556fc0b27ea912d209f202cdc51891be6
-  data.tar.gz: e475ed118ceb345985623d2e3f3694454a5bacb5d3886c25d3bfb7bcf0a63f42ee2a3e19cee6d6af30e5e2e1ccb31b8bdc23e1c63bc0068d67f0411d8c27b52d
+  metadata.gz: fc05e086ff8c61ff82c9ab7fb848637da6985464e8e7ee9ca5eeb2146441d60d1bc3b5ea4b64592c9d04a4b1d2e14b17b61634823545b30a17436bf5ed073adb
+  data.tar.gz: 62c0fedfcd7a15b09f2b217a673e1609027b1bb5f61af4836a8307253ee0e114ed0a3ef8fdf3fa9ebc476fca0f4d54eb18e501f409cc2538706570cb71b82840

data/CHANGELOG.md

@@ -0,0 +1,135 @@
+# Changelog
+
+## [master]
+
+[master]: https://github.com/mishina2228/nova_git_stats/compare/v2.3.0...master
+
+## [2.3.0]
+
+[2.3.0]: https://github.com/mishina2228/nova_git_stats/compare/v2.2.0...2.3.0
+
+* Breaking Changes
+  * Stop bundling jQuery and Bootstrap assets
+    * Those libraries are delivered by CDN, so an Internet connection is required now.
+
+* Changes
+  * Enable `frozen_string_literal` by adding the magic comment to all files
+  * Updated Bootstrap from v3.3.7 to v5.0.2
+
+* Enhancements
+  * Include documents and license in the package
+  * Replace the project name with new one in the visible part
+
+* Bugfixes
+  * Fixed highlighting of active tabs
+
+## [2.2.0]
+
+[2.2.0]: https://github.com/mishina2228/nova_git_stats/compare/v2.1.2...2.2.0
+
+* Features
+  * Renamed to NovaGitStats(nova_git_stats) from GitStats(git_stats)
+
+## [2.1.2]
+
+[2.1.2]: https://github.com/mishina2228/nova_git_stats/compare/v2.1.1...v2.1.2
+
+* Features
+  * Add `GitStats.version` method
+
+* Changes
+  * Move `HashInitializable` under `GitStats` namespace
+  * Add support for actionview 7.0
+  * Add support for activesupport 7.0
+
+* Bugfixes
+  * Expand `path` and `out_path` to the absolute path
+    * Previously, when the following command was executed, the result was saved in `./~/output/`.
+
+      ```sh
+      git_stats generate -o ~/output/
+      ```
+
+      It has been fixed so that the results are saved in `~/output` now.
+
+* Enhancements
+  * Introduce `Update GitStats::Inspector` for debugging
+    * Define `#to_s`, `#inspect` and `#pretty_print` to reduce the amount of information displayed by those methods.
+  * Replace `require` with `require_relative` if possible
+
+## [2.1.1]
+
+[2.1.1]: https://github.com/mishina2228/nova_git_stats/compare/v2.1.0...v2.1.1
+
+* Changes
+  * Remove json_pure from dependency which is no longer needed
+  * Remove pry from development dependency
+
+* Enhancements
+  * Introduced dependabot
+  * Run RuboCop on GitHub Action
+  * Fix style
+  * Update documents for CLI options
+  * Remove unneeded files from the gem package
+  * Use Gemfile instead of Gem::Specification#add_development_dependency
+
+## [2.1.0]
+
+[2.1.0]: https://github.com/mishina2228/nova_git_stats/compare/v2.0.0...v2.1.0
+
+* Breaking Changes
+  * Dropped support for IE8 and earlier
+
+* Changes
+  * Updated jQuery from v1.8.2 to v3.6.0
+  * Updated Bootstrap from v2.1.1 to v3.3.7
+    * Changed vertical tabs to horizontal
+    * Changed the appearance of the hamburger icon
+
+## 2.0.0
+
+* Breaking Changes
+  * Dropped support for Ruby 2.4 and earlier
+  * Added support for Ruby 2.5 +
+
+* Features
+  * Added `git_stats version` command
+  * Added graphs of changed/added/deleted lines by date for details of each author page.  
+    The existing line graph shows the cumulative number, while the added bar graph shows the daily number.
+
+* Bugfixes
+  * Fixed the following localization:
+    * bg
+    * de
+    * es
+    * pl
+    * tr
+    * zh_cn
+    * zh_tw
+  * Returns exit 1 when a required argument is not provided
+
+* Enhancements
+  * Introduced RuboCop and following extensions:
+    * RuboCop Performance
+    * RuboCop Rake
+    * RuboCop RSpec
+  * Introduced HAML-Lint
+  * Introduced codecov
+  * Replaced FactoryGirl with FactoryBot
+  * Removed ActionPack, Introduced ActionView
+  * Updated following dependency gems:
+    * activesupport from ~> 4.2 to ~> 6.1
+    * i18n from ~> 0.8 to ~> 1.8
+    * thor from ~> 0.20 to ~> 1.0
+    * lazy_high_charts from ~> 1.5 to ~> 1.6
+  * Updated following development dependency gems:
+    * pry from ~> 0.11 to ~> 0.13
+    * rake from  ~> 12.0 to ~> 13.0
+    * rspec from ~> 3.4 to ~> 3.10
+    * simplecov from ~> 0.11 to ~> 0.21
+  * Updated following JavaScript libraries:
+    * Highstock and data export modules from v5.0.10 to v5.0.14
+
+## Earlier than 2.0.0
+
+* See the original project [tomgi/git_stats](https://github.com/tomgi/git_stats)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tomasz Gieniusz
+
+MIT License
+
+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,113 @@
+# NovaGitStats
+
+[![Gem Version](https://badge.fury.io/rb/nova_git_stats.svg)](https://badge.fury.io/rb/nova_git_stats)
+![CI](https://github.com/mishina2228/nova_git_stats/workflows/CI/badge.svg)
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://rubydoc.info/gems/nova_git_stats)
+[![Maintainability](https://api.codeclimate.com/v1/badges/118cce63cc58fef4ae47/maintainability)](https://codeclimate.com/github/mishina2228/git_stats/maintainability)
+[![codecov](https://codecov.io/gh/mishina2228/nova_git_stats/branch/master/graph/badge.svg?token=532RLO5L7A)](https://codecov.io/gh/mishina2228/nova_git_stats)
+
+**This project is forked from original [tomgi/git-stats](https://github.com/tomgi/git_stats).**
+
+NovaGitStats is a git repository statistics generator.
+It browses the repository and outputs html page with statistics.
+
+## Examples
+
+* [Bootstrap](https://mishina2228.github.io/git_stats/bootstrap)
+* [Devise](https://mishina2228.github.io/git_stats/devise)
+* [DeviseInvitable](https://mishina2228.github.io/git_stats/devise_invitable)
+* [John](https://mishina2228.github.io/git_stats/john)
+* [jQuery](https://mishina2228.github.io/git_stats/jquery)
+* [Rails](https://mishina2228.github.io/git_stats/rails)
+* [React](https://mishina2228.github.io/git_stats/react)
+* [Vue](https://mishina2228.github.io/git_stats/vue)
+
+## Installation
+
+### Existing ruby/gem environment
+
+    $ gem install git_stats
+
+### debian stretch (9.*)
+
+    # apt-get install ruby ruby-nokogiri ruby-nokogiri-diff ruby-nokogumbo
+    # gem install git_stats
+
+### Ubuntu
+
+    $ sudo apt-get install ruby ruby-dev gcc zlib1g-dev make
+    $ sudo gem install git_stats
+
+## Prerequisites
+
+* Git
+* Ruby 2.5+
+
+## Usage
+
+### Generator
+
+#### Print help
+
+    $ git_stats
+    Commands:
+      git_stats generate        # Generates the statistics of a git repository
+      git_stats help [COMMAND]  # Describe available commands or one specific command
+      git_stats version         # Show GitStats version number and quit
+
+#### Print help of the generate command
+
+    $ git_stats help generate
+    Usage:
+      git_stats generate
+
+    Options:
+      -p, [--path=PATH]                          # Path to git repository from which statistics should be generated.
+                                                 # Default: .
+      -o, [--out-path=OUT_PATH]                  # Output path where statistics should be written.
+                                                 # Default: ./git_stats
+      -l, [--language=LANGUAGE]                  # Language of written statistics.
+                                                 # Default: en
+      -f, [--first-commit-sha=FIRST_COMMIT_SHA]  # Commit from where statistics should start.
+      -t, [--last-commit-sha=LAST_COMMIT_SHA]    # Commit where statistics should stop.
+                                                 # Default: HEAD
+      -s, [--silent], [--no-silent]              # Silent mode. Don't output anything.
+      -d, [--tree=TREE]                          # Tree where statistics should be generated.
+                                                 # Default: .
+      -c, [--comment-string=COMMENT_STRING]      # The string which is used for comments.
+                                                 # Default: //
+
+    Generates the statistics of a git repository
+
+#### Start generator with default settings
+
+    $ git_stats generate
+      git rev-list --pretty=format:'%h|%at|%ai|%aE' HEAD | grep -v commit
+      git shortlog -se HEAD
+      ...
+
+#### Start generator with some parameters in long and short form
+
+    $ git_stats generate -o stats --langugage de
+      git rev-list --pretty=format:'%h|%at|%ai|%aE' HEAD | grep -v commit
+      git shortlog -se HEAD
+      ...
+
+### API usage example
+
+    > repo = GitStats::GitData::Repo.new(path: '.', first_commit_sha: 'abcd1234', last_commit_sha: 'HEAD')
+    > repo.authors
+    => [...]
+    > repo.commits
+    => [...]
+    > commit.files
+    => [...]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/bin/git_stats

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # start up the CLI
 require_relative '../lib/git_stats/cli'

data/lib/git_stats/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core_extensions/hash'
 require_relative 'core_extensions/symbol'
 require_relative 'core_extensions/enumerable'

data/lib/git_stats/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../git_stats'
 require 'thor'
 
@@ -26,9 +28,9 @@ module GitStats
       end.render_all
     end
 
-    desc 'version', 'Show GitStats version number and quit'
+    desc 'version', 'Show NovaGitStats version number and quit'
     def version
-      puts "GitStats #{GitStats::VERSION}"
+      puts "NovaGitStats #{GitStats::VERSION}"
     end
     map %w(-v --version) => :version
   end

data/lib/git_stats/command_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   class CommandParser
     def parse(command, result)

data/lib/git_stats/command_runner.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module GitStats
   class CommandRunner
     def run(path, command)
-      execute(command, path).encode!('UTF-8', 'UTF-8', invalid: :replace)
+      execute(command, path).encode('UTF-8', 'UTF-8', invalid: :replace)
     end
 
     private

data/lib/git_stats/core_extensions/enumerable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Enumerable
   def first!(&block)
     matching = find(&block)

data/lib/git_stats/core_extensions/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Hash
   def to_key_indexed_array(min_size: 0, default: nil)
     raise ArgumentError, 'all the keys must be numbers to convert to key indexed array' unless all? { |k, _v| k.is_a? Numeric }

data/lib/git_stats/core_extensions/symbol.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Symbol
   def t
     I18n.t self

data/lib/git_stats/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'inspector'
 
 module GitStats

data/lib/git_stats/git_data/activity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module GitData
     class Activity

data/lib/git_stats/git_data/author.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../hash_initializable'
 require_relative '../inspector'
 

data/lib/git_stats/git_data/blob.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../hash_initializable'
 require_relative '../inspector'
 

data/lib/git_stats/git_data/comment_stat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module GitData
     class CommentStat

data/lib/git_stats/git_data/commit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../hash_initializable'
 require_relative '../inspector'
 

data/lib/git_stats/git_data/repo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../hash_initializable'
 require_relative '../inspector'
 
@@ -122,8 +124,7 @@ module GitStats
       end
 
       def project_name
-        # TODO: WHAT
-        @project_name ||= File.expand_path(File.join(path, tree_path)).sub(File.join(File.dirname(File.expand_path(path)), ''), '')
+        @project_name ||= File.expand_path(File.join(path, tree_path)).sub(File.dirname(File.expand_path(path)) + File::SEPARATOR, '')
       end
 
       def run(command)

data/lib/git_stats/git_data/short_stat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module GitData
     class ShortStat

data/lib/git_stats/git_data/tree.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../hash_initializable'
 
 module GitStats

data/lib/git_stats/hash_initializable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module HashInitializable
     def initialize(params = {})

data/lib/git_stats/i18n.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 I18n.load_path += Dir[GitStats.root.join('config/locales/*.yml')]
 I18n.enforce_available_locales = true

data/lib/git_stats/inspector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module Inspector
     def to_s

data/lib/git_stats/stats_view/charts/activity_charts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module StatsView
     module Charts

data/lib/git_stats/stats_view/charts/authors_charts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module StatsView
     module Charts

data/lib/git_stats/stats_view/charts/chart.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module StatsView
     module Charts

data/lib/git_stats/stats_view/charts/charts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module StatsView
     module Charts

data/lib/git_stats/stats_view/charts/repo_charts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module StatsView
     module Charts

data/lib/git_stats/stats_view/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module StatsView
     class Template

data/lib/git_stats/stats_view/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../inspector'
 
 module GitStats
@@ -33,7 +35,7 @@ module GitStats
             output = Template.new(template, @layout).render(@view_data,
                                                             author: author,
                                                             links: links,
-                                                            active_page: "/authors/#{author.dirname}/#{template}")
+                                                            active_page: "authors/#{author.dirname}/#{template}")
             write(output, "#{@out_path}/authors/#{author.dirname}/#{template}.html")
           end
         end
@@ -70,7 +72,7 @@ module GitStats
       end
 
       def create_out_dir
-        FileUtils.mkdir_p(@out_path) unless Dir.exist?(@out_path)
+        FileUtils.mkdir_p(@out_path)
       end
 
       def prepare_assets

data/lib/git_stats/stats_view/view_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   module StatsView
     class ViewData

data/lib/git_stats/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module GitStats
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.3.0'
 
   def self.version
     VERSION

data/lib/git_stats.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitStats
   def self.root
     Pathname.new(File.dirname(File.dirname(__FILE__)))

data/templates/activity/_activity.haml

@@ -1,19 +1,19 @@
 .tabbable.tabs-left
   %ul.nav.nav-tabs
-    %li{class: page == :activity_by_date ? 'active' : '', role: 'presentation'}
-      %a{href: 'by_date.html'}= :activity_by_date.t
-    %li{class: page == :hour_of_day ? 'active' : '', role: 'presentation'}
-      %a{href: 'hour_of_day.html'}= :hour_of_day.t
-    %li{class: page == :day_of_week ? 'active' : '', role: 'presentation'}
-      %a{href: 'day_of_week.html'}= :day_of_week.t
-    %li{class: page == :hour_of_week ? 'active' : '', role: 'presentation'}
-      %a{href: 'hour_of_week.html'}= :hour_of_week.t
-    %li{class: page == :month_of_year ? 'active' : '', role: 'presentation'}
-      %a{href: 'month_of_year.html'}= :month_of_year.t
-    %li{class: page == :year ? 'active' : '', role: 'presentation'}
-      %a{href: 'year.html'}= :year.t
-    %li{class: page == :year_month ? 'active' : '', role: 'presentation'}
-      %a{href: 'year_month.html'}= :year_month.t
+    %li.nav-item{role: 'presentation'}
+      %a.nav-link{class: page == :activity_by_date ? 'active' : '', href: 'by_date.html'}= :activity_by_date.t
+    %li.nav-item{role: 'presentation'}
+      %a.nav-link{class: page == :hour_of_day ? 'active' : '', href: 'hour_of_day.html'}= :hour_of_day.t
+    %li.nav-item{role: 'presentation'}
+      %a.nav-link{class: page == :day_of_week ? 'active' : '', href: 'day_of_week.html'}= :day_of_week.t
+    %li.nav-item{role: 'presentation'}
+      %a.nav-link{class: page == :hour_of_week ? 'active' : '', href: 'hour_of_week.html'}= :hour_of_week.t
+    %li.nav-item{role: 'presentation'}
+      %a.nav-link{class: page == :month_of_year ? 'active' : '', href: 'month_of_year.html'}= :month_of_year.t
+    %li.nav-item{role: 'presentation'}
+      %a.nav-link{class: page == :year ? 'active' : '', href: 'year.html'}= :year.t
+    %li.nav-item{role: 'presentation'}
+      %a.nav-link{class: page == :year_month ? 'active' : '', href: 'year_month.html'}= :year_month.t
 
   .tab-content
     .tab-pane.active

data/templates/assets/menu.css

@@ -1,9 +1,17 @@
+* {
+    font-size: 14px;
+}
+
 .menu-icon {
     width: 42px;
     height: 35px;
     padding: 5px 8px;
 }
 
+.menu-icon:hover {
+    background-color: #cbcbcb;
+}
+
 .navbar-collapse > .nav > li > a {
     font-weight: bold;
 }
@@ -19,8 +27,9 @@
 }
 
 .navbar-collapse > .nav > .active > a {
-    box-shadow: inset 0 3px 8px rgba(0, 0, 0, 0.15);
-    -webkit-box-shadow: inset 0 3px 8px rgba(0, 0, 0, 0.15);
+    box-shadow: inset 0 40px 16px rgba(0, 0, 0, 0.15);
+    -webkit-box-shadow: inset 0 40px 16px rgba(0, 0, 0, 0.15);
+    border-radius: 5px;
 }
 
 .tab-content {

data/templates/author_details/_author_details.haml

@@ -1,13 +1,13 @@
 .tabbable.tabs-left
   %ul.nav.nav-tabs
-    %li{class: page == :commits_by_date ? 'active' : ''}
-      %a{href: 'commits_by_date.html'}= :commits_by_date.t
-    %li{class: page == :changed_lines_by_date ? 'active' : ''}
-      %a{href: 'changed_lines_by_date.html'}= :changed_lines_by_date.t
-    %li{class: page == :insertions_by_date ? 'active' : ''}
-      %a{href: 'insertions_by_date.html'}= :insertions_by_date.t
-    %li{class: page == :deletions_by_date ? 'active' : ''}
-      %a{href: 'deletions_by_date.html'}= :deletions_by_date.t
+    %li.nav-item
+      %a.nav-link{class: page == :commits_by_date ? 'active' : '', href: 'commits_by_date.html'}= :commits_by_date.t
+    %li.nav-item
+      %a.nav-link{class: page == :changed_lines_by_date ? 'active' : '', href: 'changed_lines_by_date.html'}= :changed_lines_by_date.t
+    %li.nav-item
+      %a.nav-link{class: page == :insertions_by_date ? 'active' : '', href: 'insertions_by_date.html'}= :insertions_by_date.t
+    %li.nav-item
+      %a.nav-link{class: page == :deletions_by_date ? 'active' : '', href: 'deletions_by_date.html'}= :deletions_by_date.t
 
   .tab-content
     .tab-pane.active