bigfiles 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40abc4d318260355a33bfe37f192ed8b5463b0ae
-  data.tar.gz: 82e7a2cbd78368b63210e29f24f49b0fe09b8f2f
+  metadata.gz: f98e9edfdf5e80acdb888bcff5925860185cdb75
+  data.tar.gz: a7ba3c286b3fd6d54027fab10c83098dc63526d7
 SHA512:
-  metadata.gz: 5174d80ccd1b0658b8c0f30f7cee3bd6004dc213dd009f1c6a3c247d12803b92daffc7aa46b4c1c843033a7a0bc5eb4f79830508396af612a6a5c09f7cef453c
-  data.tar.gz: 99c57e01f56fe495c80c19a53db08d3e7eca5b7c188174169bc0f9394d57a230ac27ab50a61ee0da12c0bd8963cedfd6f18e568a2db0c55a9a349a0174288015
+  metadata.gz: 27c3ea11512e8608a75c0ef4dc28f2a936e637131252b8f7e72d188d02f915e6545f859d2dabd41c31dccb4f4ed2a98595dd122e0f63583c1e16983dcc2fe9f9
+  data.tar.gz: c21ba07a949deebe99b71647146ed4bed2faad4f73f041db6538b1d51b58006f91d6ce493bae3c516daa2434f4423b8ada6e65415a48d741af6058419dc15bc6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+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 both within project spaces and in public spaces
+when an individual is representing the project or its community. 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 vince.broz@bluelabs.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -0,0 +1,59 @@
+# BigFiles
+
+[![Build Status](https://travis-ci.org/apiology/bigfiles.svg?branch=master)](https://travis-ci.org/apiology/bigfiles)
+
+Simple tool to find the largest source files in your project - maybe
+to target for refactoring!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bigfiles'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install bigfiles
+```
+
+## Usage
+
+This is typically used as part of general use of the
+[quality](https://github.com/apiology/quality) gem.  You can also run
+it on the command line directly:
+
+```sh
+$ bigfiles
+165: spec/big_files/big_files_spec.rb
+76: .rubocop.yml
+59: spec/big_files/file_with_lines_spec.rb
+$
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on
+[GitHub](https://github.com/apiology/bigfiles). 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pronto::Punchlist project’s codebases,
+issue trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/apiology/bigfiles/blob/master/CODE_OF_CONDUCT.md).

data/bigfiles.gemspec

@@ -1,5 +1,6 @@
 # ; -*-Ruby-*-
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
 require 'bigfiles/version'
 
@@ -27,8 +28,11 @@ Gem::Specification.new do |s|
 
   s.add_dependency('source_finder', ['>=2'])
   s.add_development_dependency('bundler')
+  s.add_development_dependency('pronto')
+  s.add_development_dependency('pronto-punchlist')
+  s.add_development_dependency('pronto-rubocop')
+  s.add_development_dependency('quality', '~> 37')
   s.add_development_dependency('rake')
-  s.add_development_dependency('quality')
   s.add_development_dependency('rspec')
   s.add_development_dependency('simplecov')
 end

data/bin/bigfiles

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../lib/bigfiles'
 

data/lib/bigfiles.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 require_relative 'bigfiles/file_with_lines'
+require_relative 'bigfiles/option_parser'
+require_relative 'bigfiles/inspector'
 require 'source_finder/source_file_globber'
 require 'source_finder/option_parser'
 
@@ -13,71 +17,30 @@ module BigFiles
                    exiter: Kernel,
                    file_with_lines: FileWithLines,
                    source_file_globber: SourceFinder::SourceFileGlobber.new,
-                   option_parser_class: OptionParser,
-                   source_finder_option_parser: SourceFinder::OptionParser.new)
-      @io = io
-      @exiter = exiter
-      @file_with_lines = file_with_lines
-      @source_file_globber = source_file_globber
-      @option_parser_class = option_parser_class
-      @source_finder_option_parser = source_finder_option_parser
-      @options = parse_options(args)
-    end
-
-    def parse_options(args)
-      options = nil
-      @option_parser_class.new do |opts|
-        options = setup_options(opts)
-        @option_parser = opts
-      end.parse!(args)
-      options
-    end
-
-    def glob
-      @options[:glob] || @source_finder_option_parser.default_source_files_glob
-    end
-
-    def exclude_glob
-      @options[:exclude] ||
-        @source_finder_option_parser.default_source_files_exclude_glob
-    end
-
-    def add_help_option(opts, options)
-      opts.on('-h', '--help', 'This message') do |_|
-        options[:help] = true
-      end
-    end
-
-    def setup_options(opts)
-      options = {}
-      opts.banner = 'Usage: bigfiles [options]'
-      @source_finder_option_parser.add_options(opts, options)
-      add_help_option(opts, options)
-      options
-    end
-
-    def usage
-      @io.puts @option_parser
-      @exiter.exit 1
-    end
-
-    def find_analyze_and_report_on_files
-      @source_file_globber.source_files_glob = glob
-      @source_file_globber.source_files_exclude_glob = exclude_glob
-      file_list = @source_file_globber.source_files_arr
-      files_with_lines = file_list.map do |filename|
-        @file_with_lines.new(filename)
-      end
-      files_with_lines.sort.reverse[0..2].each do |file|
-        @io.puts "#{file.num_lines}: #{file.filename}"
-      end
+                   inspector_class: Inspector,
+                   option_parser_class: ::OptionParser,
+                   source_finder_option_parser: SourceFinder::OptionParser.new,
+                   bigfiles_option_parser:
+                     ::BigFiles::OptionParser
+                       .new(option_parser_class: option_parser_class,
+                            io: io,
+                            exiter: exiter,
+                            source_finder_option_parser:
+                              source_finder_option_parser),
+                   config: bigfiles_option_parser.parse_options(args))
+      @bigfiles_option_parser = bigfiles_option_parser
+      @config = config
+      @inspector = inspector_class.new(source_file_globber: source_file_globber,
+                                       config: config,
+                                       file_with_lines: file_with_lines,
+                                       io: io)
     end
 
     def run
-      if @options[:help]
-        usage
+      if @config.help
+        @bigfiles_option_parser.usage
       else
-        find_analyze_and_report_on_files
+        @inspector.find_analyze_and_report_on_files
       end
     end
   end

data/lib/bigfiles/config.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'source_finder/option_parser'
+require 'quality/threshold'
+
+module BigFiles
+  # Configuration for bigfiles gem
+  class Config
+    NUM_FILES_DEFAULT = 3
+
+    attr_reader :help, :num_files, :glob, :exclude, :minimum_high_water_mark
+    def initialize(source_finder_option_parser: SourceFinder::OptionParser.new,
+                   num_files: Config::NUM_FILES_DEFAULT,
+                   quality_threshold: ::Quality::Threshold.new('bigfiles'),
+                   minimum_high_water_mark: 300,
+                   help: false,
+                   glob: source_finder_option_parser.default_source_files_glob,
+                   exclude: source_finder_option_parser
+                     .default_source_files_exclude_glob)
+      @num_files = num_files
+      @help = help
+      @glob = glob
+      @exclude = exclude
+      @quality_threshold = quality_threshold
+      @minimum_high_water_mark = minimum_high_water_mark
+    end
+
+    def high_water_mark
+      @quality_threshold.threshold || @minimum_high_water_mark
+    end
+
+    def under_limit?(num_lines)
+      num_lines <= high_water_mark
+    end
+  end
+end

data/lib/bigfiles/file_with_lines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BigFiles
   # Encapsulates a file which has a certain number of lines
   class FileWithLines

data/lib/bigfiles/inspector.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'config'
+require_relative 'file_with_lines'
+
+# Simple tool to find the largest source files in your project.
+module BigFiles
+  # Investigate a project and generate a report on the n biggest files
+  class Inspector
+    def initialize(config: Config.new,
+                   source_file_globber: SourceFinder::SourceFileGlobber.new,
+                   file_with_lines: FileWithLines,
+                   io: Kernel)
+      @config = config
+      @source_file_globber = source_file_globber
+      @file_with_lines = file_with_lines
+      @io = io
+    end
+
+    def find_and_analyze
+      @source_file_globber.source_files_glob = @config.glob
+      @source_file_globber.source_files_exclude_glob = @config.exclude
+      file_list = @source_file_globber.source_files_arr
+      file_list.map do |filename|
+        @file_with_lines.new(filename)
+      end.sort.reverse[0..(@config.num_files - 1)]
+    end
+
+    def find_analyze_and_report_on_files
+      find_and_analyze.each do |file|
+        @io.puts "#{file.num_lines}: #{file.filename}"
+      end
+    end
+  end
+end

data/lib/bigfiles/option_parser.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'config'
+
+module BigFiles
+  # Parse options passed to bigfiles command
+  class OptionParser
+    def initialize(option_parser_class: ::OptionParser,
+                   io: Kernel,
+                   exiter: Kernel,
+                   source_finder_option_parser:)
+      @option_parser_class = option_parser_class
+      @io = io
+      @exiter = exiter
+      @source_finder_option_parser = source_finder_option_parser
+    end
+
+    def setup_options(opts)
+      options = {}
+      opts.banner = 'Usage: bigfiles [options]'
+      @source_finder_option_parser.add_options(opts, options)
+      add_help_option(opts, options)
+      add_num_files_option(opts, options)
+      options
+    end
+
+    def add_num_files_option(opts, options)
+      opts.on('-n', '--num-files number-here',
+              Integer,
+              "Top number of files to show--" \
+              "default #{Config::NUM_FILES_DEFAULT}") do |n|
+        options[:num_files] = n
+      end
+    end
+
+    def add_help_option(opts, options)
+      opts.on('-h', '--help', 'This message') { |_| options[:help] = true }
+    end
+
+    def parse_options(args)
+      options = nil
+      @option_parser_class.new do |opts|
+        options = setup_options(opts)
+        @option_parser = opts
+      end.parse!(args)
+      Config.new(**options,
+                 source_finder_option_parser: @source_finder_option_parser)
+    end
+
+    def usage
+      @io.puts @option_parser
+      @exiter.exit(1)
+    end
+  end
+end

data/lib/bigfiles/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Tool to find the largest source files in your project
 module BigFiles
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,97 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: bigfiles
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2020-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: source_finder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   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: rake
+  name: pronto
   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: pronto-punchlist
+  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: pronto-rubocop
+  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: quality
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '37'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
   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: simplecov
   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: bigfiles finds the largest source files in your project and reports on
@@ -103,11 +145,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CODE_OF_CONDUCT.md
 - License.txt
+- README.md
 - bigfiles.gemspec
 - bin/bigfiles
 - lib/bigfiles.rb
+- lib/bigfiles/config.rb
 - lib/bigfiles/file_with_lines.rb
+- lib/bigfiles/inspector.rb
+- lib/bigfiles/option_parser.rb
 - lib/bigfiles/version.rb
 homepage: http://github.com/apiology/bigfiles
 licenses:
@@ -119,17 +166,17 @@ 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.6
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Finds largest source files in a project