todos_export 0.0.1

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in todos_export.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Caught
+
+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,23 @@
+# TodosExport
+
+Export comment TODO's, FIXME's and BUG's from your code.
+
+Available export locations:
+ - Github Issues
+
+## Installation
+
+    $ gem install todos_export
+
+## Usage
+
+    $ cd /my_project/
+    $ todos_export
+
+## 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/todos_export

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'todos_export'
+
+Signal.trap(:INT, "EXIT")
+
+target = ARGV[0] || './'
+export = TodosExport::Main.new(target)
+export.execute

data/lib/todos_export.rb

@@ -0,0 +1,75 @@
+require "todos_export/version"
+require 'todos_export/github_issues'
+require "highline/import"
+require 'octokit'
+HighLine.track_eof = false
+
+module TodosExport
+  class Main
+    attr_accessor :target, :files, :exportables
+
+    def initialize(target)
+      self.target = target
+      self.exportables = []
+    end
+
+    def find_files
+      if File.file?(self.target)
+        self.files = [self.target]
+      elsif File.directory?(self.target)
+        self.files = Dir.glob(File.join(self.target, "**", "*.rb"))
+      else
+        abort "#{target} does not exist."
+      end
+
+      return self.files
+    end
+
+    def find_exportables
+      self.find_files
+
+      self.files.each do |file|
+        File.open(file) do |f|
+          f.each_with_index do |line, number|
+            search = line.scan(/(?:#)(?:| )(TODO|FIXME|BUG):?(.*)$/i)
+            if !search.empty?
+              self.exportables << {
+                :type => search[0][0].upcase,
+                :content => search[0][1].strip,
+                :file => file.gsub(/^(.\/|\/)/, ''),
+                :line => number + 1
+              }
+            end
+          end
+        end
+      end
+    end
+
+    def exportable_todos
+      self.exportables.select { |x| x[:type] == 'TODO' }
+    end
+
+    def exportable_fixmes
+      self.exportables.select { |x| x[:type] == 'FIXME' }
+    end
+
+    def exportable_bugs
+      self.exportables.select { |x| x[:type] == 'BUG' }
+    end
+
+    def execute
+      self.find_exportables
+
+      say("Found #{self.exportable_todos.size} TODO's, " \
+        "#{self.exportable_fixmes.size} FIXME's and " \
+        "#{self.exportable_bugs.size} BUG's" \
+        " in #{self.exportables.map { |x| x[:file] }.uniq.size } of #{exportables.map { |x| x[:file] }.size } files searched.")
+      say("\n")
+
+      choose do |menu|
+        menu.prompt = "Export to: "
+        menu.choice('Github Issues') { TodosExport::GithubIssues.new(self).run }
+      end
+    end
+  end
+end

data/lib/todos_export/github_issues.rb

@@ -0,0 +1,71 @@
+module TodosExport
+  class GithubIssues
+    attr_accessor :main
+
+    def initialize(main)
+      @main = main
+    end
+
+    def run
+      authenticate
+      select_repo
+      process_exportables
+    end
+
+    def authenticate
+      say("\n")
+      choose do |menu|
+        menu.prompt = "Choose authentication method: "
+
+        menu.choice('Username / Password') do
+          say("\n")
+          username = ask("Github Username:")
+          password = ask("Github Password:") { |q| q.echo = false }
+
+          @client = ::Octokit::Client.new(:login => username, :password => password)
+        end
+        menu.choice('Personal Access Token (https://github.com/settings/applications)') do
+          say("\n")
+          token = ask("Github token:")
+          @client = ::Octokit::Client.new(:oauth_token => token)
+        end
+      end
+    end
+
+    def select_repo
+      say("\n")
+      choose do |menu|
+        menu.prompt = "Choose a repository to add issues to:"
+
+        @client.repos.each do |repo|
+          menu.choice(repo.full_name) { @repo = repo.full_name }
+        end
+      end
+    end
+
+    def process_exportables
+      say("\n")
+      self.main.exportables.each do |ex|
+        say("Create a new Issue")
+        say("==================")
+        say("<%= color('Name:', :green) %>\n#{ex[:content]}")
+        say("<%= color('Description:', :green) %>\n#{ex[:content]}\n\nhttps://github.com/#{@repo}/blob/master/#{ex[:file]}#L#{ex[:line]}")
+        say("<%= color('Tags:', :green) %>\n'#{ex[:type].downcase}'")
+        say("\n")
+        create = agree("Create this issue? [y]es, [n]o")
+        if create
+          if @client.create_issue(
+            @repo,
+            ex[:content],
+            "#{ex[:content]}\n\nhttps://github.com/#{@repo}/blob/master/#{ex[:file]}#L#{ex[:line]}",
+            { :labels => ex[:type].downcase })
+
+            say("\n<%= color('Created!', :green) %>\n\n")
+          else
+            say("\n<%= color('Not created!', :red) %>\n\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/todos_export/version.rb

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

data/spec/lib/todos_export/github_isses_spec.rb

@@ -0,0 +1,11 @@
+require 'todos_export/github_issues'
+
+describe TodosExport::GithubIssues do
+  subject do
+    main = TodosExport::Main.new('spec/resources')
+    main.find_exportables
+
+    TodosExport::GithubIssues.new(main)
+  end
+
+end

data/spec/lib/todos_export_spec.rb

@@ -0,0 +1,161 @@
+require 'todos_export'
+
+describe TodosExport::Main do
+  subject do
+    TodosExport::Main.new('spec/resources')
+  end
+
+  it '#find_files' do
+    subject.find_files
+    subject.files.size.should == 3
+  end
+
+  it '#find_exportables' do
+    subject.find_exportables
+    subject.exportables.size.should == 10
+  end
+
+  it '#exportables' do
+    subject.find_exportables
+    subject.exportables.should == [
+      {
+        :type => "FIXME",
+        :content => "This is a useless class, what we really need to do is sit down and eat some cheese",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 2
+      },
+      {
+        :type => "TODO",
+        :content => "Find a kinder message",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 12
+      },
+      {
+        :type => "TODO",
+        :content => "Make a list",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 18
+      },
+      {
+        :type => "FIXME",
+        :content => "Use case statement",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 22
+      },
+      {
+        :type => "TODO",
+        :content => "Add more cheese types",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 26
+      },
+      {
+        :type => "TODO",
+        :content => "Add more region cheeses",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 35
+      },
+      {
+        :type => "TODO",
+        :content => "Personalize the class to your taste",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 41
+      },
+      {
+        :type => "BUG",
+        :content => "This should be false",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 46
+      },
+      {
+        :type => "TODO",
+        :content => "Be a better Ruby file",
+        :file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
+        :line => 1
+      },
+      {
+        :type => "BUG",
+        :content => "This should say it's a Ruby file",
+        :file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
+        :line => 2
+      }
+    ]
+  end
+
+  it '#exportable_todos' do
+    subject.find_exportables
+    subject.exportable_todos.should == [
+      {
+        :type => "TODO",
+        :content => "Find a kinder message",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 12
+      },
+      {
+        :type => "TODO",
+        :content => "Make a list",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 18
+      },
+      {
+        :type => "TODO",
+        :content => "Add more cheese types",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 26
+      },
+      {
+        :type => "TODO",
+        :content => "Add more region cheeses",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 35
+      },
+      {
+        :type => "TODO",
+        :content => "Personalize the class to your taste",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 41
+      },
+      {
+        :type => "TODO",
+        :content => "Be a better Ruby file",
+        :file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
+        :line => 1
+      }
+    ]
+  end
+
+  it '#exportable_fixmes' do
+    subject.find_exportables
+    subject.exportable_fixmes.should == [
+      {
+        :type => "FIXME",
+        :content => "This is a useless class, what we really need to do is sit down and eat some cheese",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 2
+      },
+      {
+        :type => "FIXME",
+        :content => "Use case statement",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 22
+      }
+    ]
+  end
+
+  it '#exportable_bugs' do
+    subject.find_exportables
+    subject.exportable_bugs.should == [
+      {
+        :type => "BUG",
+        :content => "This should be false",
+        :file => 'spec/resources/ruby_file_with_todos.rb',
+        :line => 46
+      },
+      {
+        :type => "BUG",
+        :content => "This should say it's a Ruby file",
+        :file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
+        :line => 2
+      }
+    ]
+  end
+end

data/spec/resources/python_file.py

@@ -0,0 +1,2 @@
+# TODO: Be a python
+print "I'm a python"

data/spec/resources/ruby_file_with_todos.rb

@@ -0,0 +1,49 @@
+# There are many things TODO but this isn't a TODO: because it doesn't start with the words
+# fixme: This is a useless class, what we really need to do is sit down and eat some cheese
+# This is a class for cheeses
+
+class Cheese
+  attr_accessor :cheese
+
+  def initialize(cheese)
+    if cheese
+      @cheese = cheese
+    else
+      #TODO: Find a kinder message
+      puts "Pick a tasty cheese dammit"
+    end
+  end
+
+  def needs_bread?
+    true # TODO: Make a list
+  end
+
+  def needs_wine?
+    #FIXME: Use case statement
+    if self.cheese == 'chedar'
+      return false
+    else
+      #todo: Add more cheese types
+      return true
+    end
+  end
+
+  def has_region_name?
+    if self.cheese == 'brie'
+      return true
+    else
+      #todo Add more region cheeses
+      return false
+    end
+  end
+
+  def yum?
+    # TODO Personalize the class to your taste
+    return true
+  end
+
+  def yuck?
+    # BUG: This should be false
+    return true
+  end
+end

data/spec/resources/ruby_file_without_todos.rb

@@ -0,0 +1,6 @@
+class Bread
+  def fresh?
+    # I'm never up early enough
+    return false
+  end
+end

data/spec/resources/sub_directory/another_ruby_file_with_todos.rb

@@ -0,0 +1,3 @@
+# TODO: Be a better Ruby file
+# BUG: This should say it's a Ruby file
+puts "I'm a Perl file"

data/todos_export.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'todos_export/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "todos_export"
+  spec.version       = TodosExport::VERSION
+  spec.authors       = ["Ryan Caught"]
+  spec.email         = ["rcaught@gmail.com"]
+  spec.description   = %q{Export comment Todo's, Fixme's and Bug's from your code}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/rcaught/todos_export"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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"
+
+  spec.add_runtime_dependency "highline"
+  spec.add_runtime_dependency "octokit"
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "system_timer"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification 
+name: todos_export
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Caught
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: octokit
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: system_timer
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+description: Export comment Todo's, Fixme's and Bug's from your code
+email: 
+- rcaught@gmail.com
+executables: 
+- todos_export
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/todos_export
+- lib/todos_export.rb
+- lib/todos_export/github_issues.rb
+- lib/todos_export/version.rb
+- spec/lib/todos_export/github_isses_spec.rb
+- spec/lib/todos_export_spec.rb
+- spec/resources/python_file.py
+- spec/resources/ruby_file_with_todos.rb
+- spec/resources/ruby_file_without_todos.rb
+- spec/resources/sub_directory/another_ruby_file_with_todos.rb
+- todos_export.gemspec
+has_rdoc: true
+homepage: https://github.com/rcaught/todos_export
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Export comment Todo's, Fixme's and Bug's from your code
+test_files: 
+- spec/lib/todos_export/github_isses_spec.rb
+- spec/lib/todos_export_spec.rb
+- spec/resources/python_file.py
+- spec/resources/ruby_file_with_todos.rb
+- spec/resources/ruby_file_without_todos.rb
+- spec/resources/sub_directory/another_ruby_file_with_todos.rb