source_finder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baf95ccd1d9c73a477fcc9fb336ca869c6bd3af4
+  data.tar.gz: fc674fa35fa9d2ad4628df5fdf5b6892c4c21738
+SHA512:
+  metadata.gz: 912857f1347028dc410fb261f500c6afce4ade35bd8ed3a7f9d3d33a574e6a776c85d55667f9fd664e82795417b75a2425faa83b7d692084f488caa39caed558
+  data.tar.gz: ce1dacfdc35223cddec9bac55b0a8e6ea070454be61550ac3408315db90f866d7411bbfeb94fe3418eb4b5c61ed43d3bcb9bdc2d5ea0a4ce216eae3cef0406be

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/coverage/.resultset.json
+/coverage/assets/
+/coverage/index.html
+/pkg

data/.rubocop.yml

@@ -0,0 +1,32 @@
+# I like trailing commas in maps.  They let me insert new elements and
+# see them as one line in a diff, not two.
+TrailingComma:
+  Enabled: false
+
+# I use keyword arguments for a poor man's dependency injection to cut
+# down on the magic in my tests.
+ParameterLists:
+  CountKeywordArgs: false
+
+# If i'm using one function name and returning the contents of an
+# attribute, that's OK.  The alternative would be this, which I find
+# confusing and often not really what I mean:
+#
+# attr_reader :something_else
+# alias_method :something, :something_else
+TrivialAccessors:
+   ExactNameMatch: true
+
+#
+# Add 'XXX' to the standard list
+#
+Style/CommentAnnotation:
+   Keywords:
+    - "TOD\
+       O"
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+    - "XX\
+       X"

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,9 @@
+before_install: gem install bundler
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby-head
+  - ruby-head  
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in source_finder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Vince Broz
+
+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,10 @@
+## SourceFinder
+
+[![Circle CI](https://circleci.com/gh/apiology/source_finder.svg?style=svg)](https://circleci.com/gh/apiology/source_finder)
+
+[![Build Status](https://travis-ci.org/apiology/source_finder.svg)](https://travis-ci.org/apiology/source_finder)
+
+SourceFinder's job is to find source files in your project in a configurable way
+--useful for things like static analysis quality tools.
+
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+Dir['lib/tasks/**/*.rake'].each { |t| load t }
+
+desc 'Default: Run specs and check quality.'
+task default: [:localtest]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "source_finder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,6 @@
+dependencies:
+  pre:
+    - gem install bundler
+test:
+  override:
+    - bundle exec rake localtest

data/coverage/.last_run.json

@@ -0,0 +1 @@
+{"result":{"covered_percent": 0.00}}

data/lib/source_finder/source_file_globber.rb

@@ -0,0 +1,67 @@
+module SourceFinder
+  # Give configuration, finds source file locations by using an
+  # inclusion and exclusion glob
+  class SourceFileGlobber
+    # See README.md for documentation on these configuration parameters.
+
+    attr_accessor :ruby_dirs, :source_dirs, :extra_files, :extra_ruby_files,
+                  :ruby_file_extensions, :source_file_extensions, :exclude_files
+
+    def ruby_dirs
+      @ruby_dirs ||= %w(src app lib test spec feature)
+    end
+
+    def source_dirs
+      @source_dirs ||= ruby_dirs.clone
+    end
+
+    def extra_files
+      @extra_files ||= extra_ruby_files.clone.concat(%w(Dockerfile))
+    end
+
+    def extra_ruby_files
+      @extra_ruby_files ||= %w(Rakefile)
+    end
+
+    def exclude_files
+      @exclude_files ||= []
+    end
+
+    def source_file_extensions
+      @source_file_extensions ||=
+        "#{ruby_file_extensions},swift,cpp,c,java,py,clj,cljs,scala,js," \
+        'yml,sh,json'
+    end
+
+    def source_files_glob(extra_source_files = extra_files,
+                          dirs = source_dirs,
+                          extensions = source_file_extensions)
+      "{#{extra_source_files.join(',')}," \
+        "{*,.*}.{#{extensions}}," +
+        File.join("{#{dirs.join(',')}}",
+                  '**',
+                  "{*,.*}.{#{extensions}}") +
+        '}'
+    end
+
+    def source_files_exclude_glob
+      "{#{exclude_files.join(', ')}}"
+    end
+
+    def ruby_file_extensions
+      @ruby_file_extensions ||= 'rb,rake,gemspec'
+    end
+
+    def ruby_files_glob
+      source_files_glob(extra_ruby_files, ruby_dirs, ruby_file_extensions)
+    end
+
+    def ruby_files
+      (@globber.glob(ruby_files_glob) - exclude_files).join(' ')
+    end
+
+    def initialize(globber: fail)
+      @globber = globber
+    end
+  end
+end

data/lib/source_finder/version.rb

@@ -0,0 +1,4 @@
+# SourceFinder finds source and documentation files within a project.
+module SourceFinder
+  VERSION = '0.1.0'
+end

data/lib/source_finder.rb

@@ -0,0 +1,5 @@
+require "source_finder/version"
+
+module SourceFinder
+  # Your code goes here...
+end

data/lib/tasks/ci.rake

@@ -0,0 +1 @@
+task ci: :localtest

data/lib/tasks/clear_metrics.rake

@@ -0,0 +1,5 @@
+task :clear_metrics do |_t|
+  ret =
+    system('git checkout coverage/.last_run.json metrics/*_high_water_mark')
+  fail unless ret
+end

data/lib/tasks/default.rake

@@ -0,0 +1 @@
+task default: :localtest

data/lib/tasks/feature.rake

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+desc 'Run features'
+RSpec::Core::RakeTask.new(:feature) do |task|
+  task.pattern = 'feature/**/*_spec.rb'
+  task.rspec_opts = '--format doc'
+end

data/lib/tasks/localtest.rake

@@ -0,0 +1 @@
+task localtest: [:clear_metrics, :spec, :quality]

data/lib/tasks/quality.rake

@@ -0,0 +1,6 @@
+require 'quality/rake/task'
+
+Quality::Rake::Task.new do |task|
+  task.skip_tools = ['reek']
+  task.output_dir = 'metrics'
+end

data/lib/tasks/spec.rake

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+  task.rspec_opts = '--format doc'
+end

data/metrics/bigfiles_high_water_mark

@@ -0,0 +1 @@
+300

data/metrics/brakeman_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/cane_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/flay_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/flog_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/punchlist_high_water_mark

@@ -0,0 +1 @@
+1

data/metrics/rubocop_high_water_mark

@@ -0,0 +1 @@
+2

data/source_finder.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'source_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'source_finder'
+  spec.version       = SourceFinder::VERSION
+  spec.authors       = ['Vince Broz']
+  spec.email         = ['vince@broz.cc']
+
+  spec.summary       = 'SourceFinder finds source and documentation files ' \
+                       'within a project.'
+  spec.homepage      = 'https://github.com/apiology/source_finder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'quality'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: source_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vince Broz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: quality
+  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: 
+email:
+- vince@broz.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- .ruby-version
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- coverage/.last_run.json
+- lib/source_finder.rb
+- lib/source_finder/source_file_globber.rb
+- lib/source_finder/version.rb
+- lib/tasks/ci.rake
+- lib/tasks/clear_metrics.rake
+- lib/tasks/default.rake
+- lib/tasks/feature.rake
+- lib/tasks/localtest.rake
+- lib/tasks/quality.rake
+- lib/tasks/spec.rake
+- metrics/bigfiles_high_water_mark
+- metrics/brakeman_high_water_mark
+- metrics/cane_high_water_mark
+- metrics/flay_high_water_mark
+- metrics/flog_high_water_mark
+- metrics/punchlist_high_water_mark
+- metrics/rubocop_high_water_mark
+- source_finder.gemspec
+homepage: https://github.com/apiology/source_finder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: SourceFinder finds source and documentation files within a project.
+test_files: []