codefuckery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5677274dbecfb4478d1b6e3b9ac8c1c299445a51d72a78d48c7b85a2e26ef2b2
+  data.tar.gz: d76e7811d17c046cee4f6620dcf5af6e43c9a4bcf57c8555385d5d8d739436d8
+SHA512:
+  metadata.gz: 3ce38557f659a1a51e295dc170d845a7035d402f9fad223e138f5d33e911d2dd93edc2a15e2c019335d0606a445d9b5a5b2de466ac0b298148de85f65fcf7c00
+  data.tar.gz: 5b78faaeb513b8292eb80741f135623116e4de5d122fc19517fe49d6761150c7fe81aae54733695dc60b0df40181b26fec862837e850069ce5c92f3fd5084ac5

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+debug_install.sh

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.6.3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    codefuckery (0.0.1)
+      clamp (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    clamp (1.3.1)
+    minitest (5.13.0)
+    rake (13.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codefuckery!
+  minitest
+  rake
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Martin Höller
+
+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,69 @@
+# Codefuckery
+
+Find out how fucked up your code is.
+
+[![Build Status](https://travis-ci.com/martinhoeller/codefuckery.svg?token=KWVpavqFr8Za2Z8HmJKj&branch=master)](https://travis-ci.com/martinhoeller/codefuckery)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'codefuckery'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install the gem:
+
+```
+gem install codefuckery
+```
+
+## Usage
+Run `codefuckery` from the command line. Provide the directory with your source code as a parameter.
+By default it will count the words `fuck`, `shit` and `sorry` recursively in all files.
+
+```
+$ codefuckery path/to/your/source
+```
+
+Output:
+```
+  fuck: 4
+  shit: 12
+  sorry: 0
+
+Your code is a bit fucked up 💩
+```
+
+To limit the search to certain file types add the `--filetypes` parameter with a comma-delimited list of file extensions:
+
+```
+$ codefuckery --filetypes html,css,js path/to/your/source
+```
+
+`codefuckery` lets you customize the word list:
+
+```
+$ codefuckery --words fixme,todo,refactor path/to/your/source
+```
+
+Use regular expressions for really powerful searches for really fuuuuucked up situations. This will find comments like `// This code is shiiiit. Sooorrrry for fuuuucking up so bad`
+
+```
+$ codefuckery --words fu+ck,shi+t,so+rr+y path/to/your/source
+```
+
+If you want to limit the search to the specified directory only (excluding sub-directories) provide the `--no-recursive` option:
+
+```
+$ codefuckery --no-recursive path/to/your/source
+```
+
+## Contributing
+Feel free to contribute to `codefuckery`. Just submit a pull request with your suggestion. If you find any bugs please open a [new GitHub issue](https://github.com/martinhoeller/codefuckery/issues/new).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/codefuckery

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'clamp'
+require_relative '../lib/codefuckery'
+
+Clamp do
+    parameter "DIRECTORY", "Source directory to be checked", :attribute_name => :directory
+
+    option ["--filetypes", "-f"], "FILETYPES", "Comma-delimited list of file types, e.g.: rb,java,swift. By default all files are checked.", default: '' do |s|
+        s.split(/\s*,\s*/).map { |ext| ".#{ext}"}
+    end
+
+    option ["--words", "-w"], "WORDS", "Comma-delimited list of words to count, e.g.: fixme,fuck,refactor. (default: \"fuck,shit,sorry\")" do |s|
+        s.split(/\s*,\s*/)
+    end
+
+    option ["--[no-]recursive"], :flag, "Recursively check files in DIRECTORY and all sub-directories.", default: true
+
+    option ["--version", "-v"], :flag, "Shows codefuckery version" do
+        puts "codefuckery #{Codefuckery::VERSION}"
+        exit(0)
+    end
+
+    def execute
+        word_counts = Codefuckery::Counter.count(directory, filetypes, words, recursive?)
+
+        if word_counts == nil
+            exit(-1)
+        end
+
+        print_results(word_counts)
+    end
+
+    private
+    def print_results(word_counts)
+        total_count = 0
+        word_counts.each { |word,count|
+            puts "  #{word}: #{count}"
+            total_count += count
+        }
+
+        puts ""
+        if total_count == 0
+            puts "You have a wholesome codebase 🙏"
+        else
+            puts "Your code is a bit fucked up 💩"
+        end
+    end
+end

data/codefuckery.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codefuckery/version'
+
+Gem::Specification.new do |s|
+    s.name        = 'codefuckery'
+    s.version     = Codefuckery::VERSION
+    s.date        = '2019-11-09'
+    s.summary     = 'Measure how fucked-up your code is'
+    s.description = 'Counts the occurrences of swearwords in your code.'
+    s.authors     = ['Martin Höller']
+    s.email       = 'martin@martinhoeller.net'
+    s.homepage    = 'https://github.com/martinhoeller/codefuckery'
+    s.license     = 'MIT'
+
+    s.files       = `git ls-files -z`.split("\x0")
+    s.require_paths = ['lib']
+    s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+    s.add_dependency 'clamp', '~> 1.3'
+    s.add_development_dependency 'rake'
+    s.add_development_dependency 'minitest'
+end

data/lib/codefuckery.rb

@@ -0,0 +1,3 @@
+require_relative "codefuckery/version"
+require_relative "codefuckery/default_words"
+require_relative "codefuckery/counter"

data/lib/codefuckery/counter.rb

@@ -0,0 +1,60 @@
+module Codefuckery
+    class Counter
+        def self.count(directory, filetypes, words, recursive)
+            if !File.exists?(directory)
+                puts "ERROR: '#{directory}' does not exist"
+                return nil
+            end
+
+            if !File.directory?(directory)
+                puts "ERROR: '#{directory}' is not a directory"
+                return nil
+            end
+
+            paths = create_paths(directory, filetypes, recursive)
+
+            if words == nil || words.empty?
+                words = Codefuckery::DEFAULT_WORDS
+            end
+
+            word_counts = {}
+            words.each { |w| word_counts[w] = 0 }
+            paths.each { |p| count_in_file(p, words, word_counts) }
+
+            word_counts
+        end
+
+        private
+        def self.create_paths(directory, filetypes, recursive)
+            expanded_directory = File.expand_path(directory)
+            pattern = recursive ? '**/*' : '**'
+            Dir.glob("#{expanded_directory}/#{pattern}").select { |fn| should_include(fn, filetypes) }
+        end
+
+        private
+        def self.should_include(file, filetypes)
+            basename = File.basename(file)
+            if ['..', '.', '.git', '__MACOSX', '.DS_Store'].include? basename
+                return false
+            end
+
+            if File.directory?(file)
+                return false
+            end
+
+            extension = File.extname(file).strip.downcase
+            should_include = true
+            if !filetypes.empty?
+                should_include = !extension.empty? && (filetypes.include? extension)
+            end
+
+            should_include
+        end
+
+        private
+        def self.count_in_file(file, words, word_counts)
+            data = File.read(file).force_encoding("ISO-8859-1").encode("utf-8", replace: nil)
+            words.each { |w| word_counts[w] += data.scan(/#{w}/i).count }
+        end
+    end
+end

data/lib/codefuckery/default_words.rb

@@ -0,0 +1,3 @@
+module Codefuckery
+    DEFAULT_WORDS = ['fuck', 'shit', 'sorry']
+end

data/lib/codefuckery/version.rb

@@ -0,0 +1,3 @@
+module Codefuckery
+    VERSION = '0.0.1' unless defined?(Codefuckery::VERSION)
+end

data/test/test_counter.rb

@@ -0,0 +1,62 @@
+require 'minitest/autorun'
+require 'codefuckery'
+
+describe Codefuckery::Counter do
+    describe "when directory does not exist" do
+        it "must return nil" do
+            File.stub :exists?, false do
+                assert_nil Codefuckery::Counter.count('dir', [], [], false)
+            end
+        end
+    end
+
+    describe "when directory is not a directory" do
+        it "must return nil" do
+            File.stub :directory?, false do
+                assert_nil Codefuckery::Counter.count('dir', [], [], false)
+            end
+        end
+    end
+
+    describe "given a list of file types" do
+        it "should only count the matching files" do
+            Dir.stub :glob, ['file1.x', 'file2.y', 'file3.z'] do
+                assert_equal ['file1.x', 'file2.y'],
+                    Codefuckery::Counter.create_paths('dir', ['.x', '.y'], false)
+            end
+        end
+    end
+
+    describe "given a file with two occurences of poop" do
+        it "should return a count of 2 for the word poop" do
+            word_counts = {'poop' => 0}
+
+            File.stub :read, "this test is poop poop" do
+                Codefuckery::Counter.count_in_file('file', ['poop'], word_counts)
+                assert_equal 2, word_counts['poop']
+            end
+        end
+    end
+
+    describe "given an existing word count" do
+        it "should increase the count" do
+            word_counts = {'poop' => 1}
+
+            File.stub :read, "this test is poop poop" do
+                Codefuckery::Counter.count_in_file('file', ['poop'], word_counts)
+                assert_equal 3, word_counts['poop']
+            end
+        end
+    end
+
+    describe "given a word is a regex" do
+        it "should find all matching occurences" do
+            word_counts = {'poo+p' => 0}
+
+            File.stub :read, "this test is poop poooop" do
+                Codefuckery::Counter.count_in_file('file', ['poo+p'], word_counts)
+                assert_equal 2, word_counts['poo+p']
+            end
+        end
+    end
+end

data/test/test_default_words.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'codefuckery'
+
+class DefaultWordsTest < Minitest::Test
+  def test_default_words_exists
+    refute_empty Codefuckery::DEFAULT_WORDS
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: codefuckery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Höller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: minitest
+  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: Counts the occurrences of swearwords in your code.
+email: martin@martinhoeller.net
+executables:
+- codefuckery
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/codefuckery
+- codefuckery.gemspec
+- lib/codefuckery.rb
+- lib/codefuckery/counter.rb
+- lib/codefuckery/default_words.rb
+- lib/codefuckery/version.rb
+- test/test_counter.rb
+- test/test_default_words.rb
+homepage: https://github.com/martinhoeller/codefuckery
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Measure how fucked-up your code is
+test_files: []