cruft 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*DS_store

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jure Triglav
+
+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,46 @@
+![Cruft](http://i.imgur.com/Y5JOL.jpg)
+
+The Hardvard Cruft Laboratory, birthplace of the term 'cruft'. Image by @brettstil.
+
+# Cruft
+
+Cruft enables you to keep track of workarounds you had to implement in order
+to make your code work at the time your code was written. Years later,
+the assumptions you made when the code was written, may no longer hold true, while
+your code is still written with those assumptions and is needlessly complex.
+
+Cruft compiles a Cruftfile by looking at all Ruby files in your `app` directory,
+and finding comments which start with `#cruft:`. Every line until the next line that is not a comment,
+will be included in the `Cruftfile`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cruft'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cruft
+
+## Usage
+
+You cd into the Rails app directory:
+
+    $ cd /path/to/rails_app
+
+And run cruft with bundle exec:
+
+    $ bundle exec cruft
+
+## 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. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/cruft

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+begin
+  require 'bundler'
+  Bundler.setup
+rescue Exception => e
+end
+
+here = File.expand_path(File.dirname __FILE__)
+$:<< "#{here}/../lib"
+
+require 'cruft'
+
+CruftCollector.collect

data/cruft.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cruft/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jure Triglav"]
+  gem.email         = ["me@juretriglav.si"]
+  gem.description   = %q{Keeps a cruft.txt file in the app directory, which collects #cruft: notes from the app source code in a single place.}
+  gem.summary       = %q{Cruft manager}
+  gem.homepage      = "https://github.com/jure/cruft"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cruft"
+  gem.require_paths = ["lib"]
+  gem.version       = Cruft::VERSION
+end

data/lib/cruft.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__))
+require "cruft/version"
+require 'cruft/cruft_collector'
+
+module Cruft
+
+end

data/lib/cruft/cruft_collector.rb

@@ -0,0 +1,53 @@
+module CruftCollector
+  class << self
+    def app_dir
+      @app_dir || "app"
+    end
+
+    def app_dir=(dir)
+      @app_dir = dir
+    end
+
+    def get_files(options={})
+      files = []
+      begin
+        Dir.chdir(app_dir) do
+          files = Dir['**/*.rb']
+        end
+      rescue SystemCallError
+        puts "No cruftworthy files found in directory 'app'."
+        exit 1
+      end
+      files
+    end
+
+    def get_cruft_from_file(file)
+      cruft = []
+      cruft_count = -1
+      cruft_mode = false
+
+      File.readlines(File.join(app_dir, file)).each_with_index do |line, index|
+        if cruft_mode && line =~ /^\s*#/
+          cruft[cruft_count] += line
+        elsif line =~ /^\s*#cruft:/
+          cruft_count += 1
+          cruft[cruft_count] = "#{DateTime.now.to_s}, File: #{file} Line number: #{index}\n"
+          cruft[cruft_count] += line
+          cruft_mode = true
+        else
+          cruft_mode = false
+        end
+      end
+      cruft
+    end
+
+    def collect(options={})
+      File.open('Cruftfile', 'w') do |cruftfile|
+        get_files.each do |file|
+          cruftfile.write(get_cruft_from_file(file).join('\n'))
+        end
+      end
+    end
+
+  end
+end

data/lib/cruft/version.rb

@@ -0,0 +1,3 @@
+module Cruft
+  VERSION = "0.0.1"
+end

data/lib/tasks/collect_cruft.rb

@@ -0,0 +1,7 @@
+cruft_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
+
+desc "Collect cruft (#cruft:) comments into a single Cruftfile"
+task :collect_cruft => :environment do
+  require "#{cruft_lib}/cruft/cruft_collector"
+  CruftCollector.collect(options)
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: cruft
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jure Triglav
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-16 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Keeps a cruft.txt file in the app directory, which collects #cruft:
+  notes from the app source code in a single place.'
+email:
+- me@juretriglav.si
+executables:
+- cruft
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/cruft
+- cruft.gemspec
+- lib/cruft.rb
+- lib/cruft/cruft_collector.rb
+- lib/cruft/version.rb
+- lib/tasks/collect_cruft.rb
+homepage: https://github.com/jure/cruft
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cruft manager
+test_files: []
+has_rdoc: