dooie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f67cf8190c557842a8ded34f60f275782f39328c
+  data.tar.gz: 657fe272f9b5bdbeb3380da8623bbf6f564d234e
+SHA512:
+  metadata.gz: c9ed3bf2e71af77195e603e604cd3d838dcc1753f64eaa44c3447a7b4fc77ab5d7ca3b098fe85556a3cd0d931c689148b3d78047eca55a0bf0911801308cbb3d
+  data.tar.gz: 885666f212d0775eb2de942d2e3632595f912c4afe00d17c5bc4a9840111d18b7f693f7150a24c9687dc4766172d69e34b9f346a790e65998f72f2a7284b6d6f

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dooie.gemspec
+gemspec
+
+gem 'pry-nav'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Cameron Kidman
+
+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,29 @@
+# Dooie
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dooie'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dooie
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/dooie

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'dooie'
+
+new_dooie = Dooie::TodoFinder.new
+
+new_dooie.run

data/dooie.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dooie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dooie"
+  spec.version       = Dooie::VERSION
+  spec.authors       = ["Joey Ferguson"]
+  spec.email         = ["fergmastaflex@gmail.com"]
+  spec.description   = 'Finds task comments in your repo and creates a list'
+  spec.summary       = 'We all add comments to our code that let us know we need to come back and do something. 
+                        This finds those and puts them in a file for you so you don\'t lose them'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   << 'dooie'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/dooie.rb

@@ -0,0 +1,57 @@
+require "dooie/version"
+
+module Dooie
+  class TodoFinder
+
+    TODO_PATTERNS = [/#+(\s)*TODO(\:)*/i]
+    TODO_FILE_HEADER = "Here are your TODO items \n"
+
+    def initialize
+      @todo_items = find_todo_items
+      @todo_file = File.new('todo_items.txt', 'w')
+    end
+
+    def run
+      create_todo_file(@todo_items)
+    end
+
+    def create_todo_file(todo_items)
+      todo_items.each do |item|
+        @todo_file.write(item)
+      end
+    end
+
+    def extract_and_format_todos(line)
+      clean_line = line.scan(/#.*/).first
+      TODO_PATTERNS.each do |pattern|
+        clean_line.gsub!(pattern,'').strip!
+      end
+      clean_line
+    end
+
+    def find_todo_items
+      todo_items = []
+
+      files_with_todos.each do |file|
+        text = File.read(file)
+        text.each_line do |line| 
+          next unless TODO_PATTERNS.any?{ |pattern| line =~ pattern }
+          todo_items << "[] #{extract_and_format_todos(line)} \n"
+        end
+      end
+
+      todo_items
+    end
+
+    def files_with_todos
+      files_with_todos = []
+
+      Dir['**/*.rb'].each do |file|
+        text = File.read(file)
+        files_with_todos << file if TODO_PATTERNS.any?{ |pattern| text =~ pattern }
+      end
+
+      files_with_todos
+    end
+  end
+end

data/lib/dooie/version.rb

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

data/spec/fixtures/another_fake_file_with_todos.rb

@@ -0,0 +1,5 @@
+class AnotherFakeFileWithTodos
+  def foo
+    @bar = "this is just a test" ## TODO: Again, just a test.
+  end
+end

data/spec/fixtures/fake_file_with_todos.rb

@@ -0,0 +1,5 @@
+class FakeFileWithTodos
+  def foo
+    @bar = "this is just a test" ## TODO: Again, just a test.
+  end
+end

data/spec/fixtures/fake_file_without_todos.rb

@@ -0,0 +1,5 @@
+class FakeFileWithoutTodos
+  def foo
+    @bar = "this is just a test"
+  end
+end

data/spec/lib/dooie_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe "TodoFinder" do
+
+  subject { ::Dooie::TodoFinder.new }
+
+  let(:todo_items) { subject.find_todo_items }
+  let(:line) { '@bar = "this is just a test" ## TODO: Again, just a test.' }
+  let(:clean_line) { 'Again, just a test.' }
+
+  describe 'create_todo_file' do
+    it 'should create file containing todo items' do
+      subject.create_todo_file(todo_items)
+      expect(Dir['**/todo_items.txt'].count).to eq(1)
+    end
+  end
+
+  describe 'extract_and_format_todos' do
+    it 'should cleanse a line and prepare it for the todo file' do
+      expect(subject.extract_and_format_todos(line)).to eq(clean_line)
+
+    end
+  end
+
+  describe 'files_with_todos' do
+    it 'should find files that contain TODO comments' do
+      expect(subject.find_todo_items.count).to eq(3)
+    end
+  end
+
+  describe 'find_todo_items' do
+    it 'should return an array of todo items to parse' do
+      expect(subject.find_todo_items.count).to eq(3)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# Notice there is a .rspec file in the root folder. It defines rspec arguments
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default, :development, :test)
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.after(:suite) do
+    FileUtils.rm_rf(Dir["**/todo_items.txt"])
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: dooie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joey Ferguson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  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: 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'
+description: Finds task comments in your repo and creates a list
+email:
+- fergmastaflex@gmail.com
+executables:
+- dooie
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dooie
+- dooie.gemspec
+- lib/dooie.rb
+- lib/dooie/version.rb
+- spec/fixtures/another_fake_file_with_todos.rb
+- spec/fixtures/fake_file_with_todos.rb
+- spec/fixtures/fake_file_without_todos.rb
+- spec/lib/dooie_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: We all add comments to our code that let us know we need to come back and
+  do something.  This finds those and puts them in a file for you so you don't lose
+  them
+test_files:
+- spec/fixtures/another_fake_file_with_todos.rb
+- spec/fixtures/fake_file_with_todos.rb
+- spec/fixtures/fake_file_without_todos.rb
+- spec/lib/dooie_spec.rb
+- spec/spec_helper.rb