todos_export 0.0.1 → 0.1.0

data/.rspec

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

data/README.md

@@ -2,6 +2,11 @@
 
 Export comment TODO's, FIXME's and BUG's from your code.
 
+[![Build Status](https://travis-ci.org/rcaught/todos_export.png)](https://travis-ci.org/rcaught/todos_export)
+[![Dependency Status](https://gemnasium.com/rcaught/todos_export.png)](https://gemnasium.com/rcaught/todos_export)
+[![Coverage Status](https://coveralls.io/repos/rcaught/todos_export/badge.png)](https://coveralls.io/r/rcaught/todos_export)
+[![Code Climate](https://codeclimate.com/github/rcaught/todos_export.png)](https://codeclimate.com/github/rcaught/todos_export)
+
 Available export locations:
  - Github Issues
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+RSpec::Core::RakeTask.new

data/bin/todos_export

@@ -1,6 +1,15 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
+
+# This is to make sure Faraday doesn't warn the user about the `system_timer` gem missing.
+old_warn, $-w = $-w, nil
+begin
+  require 'faraday'
+ensure
+  $-w = old_warn
+end
+
 require 'todos_export'
 
 Signal.trap(:INT, "EXIT")

data/lib/todos_export/github_issues.rb

@@ -53,17 +53,24 @@ module TodosExport
         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 })
+        if create && @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")
 
-            say("\n<%= color('Created!', :green) %>\n\n")
-          else
-            say("\n<%= color('Not created!', :red) %>\n\n")
+          say("Delete the comment and save the file?" \
+            "\n\nFile: #{ex[:file]}" \
+            "\nLine: #{ex[:line]}" \
+            "\nComment: #{ex[:original_content]}\n\n")
+          delete = agree("[y]es, [n]")
+          if delete
+            self.main.delete_exportable(ex[:file], ex[:line])
+            say("\n<%= color('Deleted the line', :green) %>\n\n")
           end
+        else
+          say("\n<%= color('Not created!', :red) %>\n\n")
         end
       end
     end

data/lib/todos_export/version.rb

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

data/lib/todos_export.rb

@@ -27,16 +27,19 @@ module TodosExport
 
     def find_exportables
       self.find_files
+      @exportables = []
 
       self.files.each do |file|
         File.open(file) do |f|
           f.each_with_index do |line, number|
-            search = line.scan(/(?:#)(?:| )(TODO|FIXME|BUG):?(.*)$/i)
+            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(/^(.\/|\/)/, ''),
+                :type => search[0][1].upcase,
+                :content => search[0][2].strip,
+                :original_content => search[0][0],
+                :file => file.gsub(/^(.\/)/, ''),
+                :original_file => file,
                 :line => number + 1
               }
             end
@@ -57,6 +60,24 @@ module TodosExport
       self.exportables.select { |x| x[:type] == 'BUG' }
     end
 
+    def delete_exportable(file, line)
+      lines = File.readlines(file)
+      lines.delete_at(line - 1)
+
+      File.open(file, "w") do |f|
+        lines.each { |l| f.puts(l) }
+      end
+
+      self.find_exportables
+    end
+
+    def delete_exportables
+      while !self.exportables.empty? do
+        self.delete_exportable(self.exportables[0][:file], self.exportables[0][:line])
+        self.find_exportables
+      end
+    end
+
     def execute
       self.find_exportables
 

data/spec/lib/todos_export/github_isses_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'todos_export/github_issues'
 
 describe TodosExport::GithubIssues do

data/spec/lib/todos_export_spec.rb

@@ -1,18 +1,74 @@
+require 'spec_helper'
 require 'todos_export'
+require 'tempfile'
 
 describe TodosExport::Main do
   subject do
     TodosExport::Main.new('spec/resources')
   end
 
-  it '#find_files' do
-    subject.find_files
-    subject.files.size.should == 3
+  context '#find_files' do
+    it 'finds them' do
+      subject.find_files
+      subject.files.size.should == 3
+    end
+
+    it 'clears when rerunning' do
+      subject.find_files
+      subject.files.size.should == 3
+      subject.find_files
+      subject.files.size.should == 3
+    end
   end
 
-  it '#find_exportables' do
-    subject.find_exportables
-    subject.exportables.size.should == 10
+  context '#find_exportables' do
+    it 'finds them' do
+      subject.find_exportables
+      subject.exportables.size.should == 10
+    end
+
+    it 'clears when rerunning' do
+      subject.find_exportables
+      subject.exportables.size.should == 10
+      subject.find_exportables
+      subject.exportables.size.should == 10
+    end
+  end
+
+  it '#delete_exportable' do
+    copied_file = Tempfile.new('copy_of_ruby_file_with_todos.rb')
+    copied_file.write(File.open('spec/resources/ruby_file_with_todos.rb', 'rb').read)
+    copied_file.rewind
+    s = TodosExport::Main.new(copied_file.path)
+    lines = File.readlines(copied_file.path).size
+
+    s.find_exportables
+    s.exportables.size.should == 8
+
+    while !s.exportables.empty? do
+      s.delete_exportable(s.exportables[0][:file], s.exportables[0][:line])
+      s.find_exportables
+    end
+
+    s.find_exportables
+    s.exportables.size.should == 0
+    File.readlines(copied_file.path).size.should == (lines - 8)
+  end
+
+  it '#delete_exportables' do
+    copied_file = Tempfile.new('copy_of_ruby_file_with_todos.rb')
+    copied_file.write(File.open('spec/resources/ruby_file_with_todos.rb', 'rb').read)
+    copied_file.rewind
+    s = TodosExport::Main.new(copied_file.path)
+    lines = File.readlines(copied_file.path).size
+
+    s.find_exportables
+    s.exportables.size.should == 8
+
+    s.delete_exportables
+    s.find_exportables
+    s.exportables.size.should == 0
+    File.readlines(copied_file.path).size.should == (lines - 8)
   end
 
   it '#exportables' do
@@ -21,61 +77,81 @@ describe TodosExport::Main do
       {
         :type => "FIXME",
         :content => "This is a useless class, what we really need to do is sit down and eat some cheese",
+        :original_content => "# fixme: 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',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 2
       },
       {
         :type => "TODO",
         :content => "Find a kinder message",
+        :original_content => "#TODO: Find a kinder message",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 12
       },
       {
         :type => "TODO",
         :content => "Make a list",
+        :original_content => "# TODO: Make a list",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 18
       },
       {
         :type => "FIXME",
         :content => "Use case statement",
+        :original_content => "#FIXME: Use case statement",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 22
       },
       {
         :type => "TODO",
         :content => "Add more cheese types",
+        :original_content => "#todo: Add more cheese types",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 26
       },
       {
         :type => "TODO",
         :content => "Add more region cheeses",
+        :original_content => "#todo Add more region cheeses",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 35
       },
       {
         :type => "TODO",
         :content => "Personalize the class to your taste",
+        :original_content => "# TODO Personalize the class to your taste",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 41
       },
       {
         :type => "BUG",
         :content => "This should be false",
+        :original_content => "# BUG: This should be false",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 46
       },
       {
         :type => "TODO",
         :content => "Be a better Ruby file",
+        :original_content => "# TODO: Be a better Ruby file",
         :file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
+        :original_file => "spec/resources/sub_directory/another_ruby_file_with_todos.rb",
         :line => 1
       },
       {
         :type => "BUG",
         :content => "This should say it's a Ruby file",
+        :original_content => "# BUG: This should say it's a Ruby file",
         :file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
+        :original_file => "spec/resources/sub_directory/another_ruby_file_with_todos.rb",
         :line => 2
       }
     ]
@@ -87,37 +163,49 @@ describe TodosExport::Main do
       {
         :type => "TODO",
         :content => "Find a kinder message",
+        :original_content => "#TODO: Find a kinder message",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 12
       },
       {
         :type => "TODO",
         :content => "Make a list",
+        :original_content => "# TODO: Make a list",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 18
       },
       {
         :type => "TODO",
         :content => "Add more cheese types",
+        :original_content => "#todo: Add more cheese types",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 26
       },
       {
         :type => "TODO",
         :content => "Add more region cheeses",
+        :original_content => "#todo Add more region cheeses",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 35
       },
       {
         :type => "TODO",
         :content => "Personalize the class to your taste",
+        :original_content => "# TODO Personalize the class to your taste",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => "spec/resources/ruby_file_with_todos.rb",
         :line => 41
       },
       {
         :type => "TODO",
         :content => "Be a better Ruby file",
+        :original_content => "# TODO: Be a better Ruby file",
         :file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
+        :original_file => "spec/resources/sub_directory/another_ruby_file_with_todos.rb",
         :line => 1
       }
     ]
@@ -129,13 +217,17 @@ describe TodosExport::Main do
       {
         :type => "FIXME",
         :content => "This is a useless class, what we really need to do is sit down and eat some cheese",
+        :original_content => "# fixme: 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',
+        :original_file => 'spec/resources/ruby_file_with_todos.rb',
         :line => 2
       },
       {
         :type => "FIXME",
         :content => "Use case statement",
+        :original_content => "#FIXME: Use case statement",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => 'spec/resources/ruby_file_with_todos.rb',
         :line => 22
       }
     ]
@@ -147,13 +239,17 @@ describe TodosExport::Main do
       {
         :type => "BUG",
         :content => "This should be false",
+        :original_content => "# BUG: This should be false",
         :file => 'spec/resources/ruby_file_with_todos.rb',
+        :original_file => 'spec/resources/ruby_file_with_todos.rb',
         :line => 46
       },
       {
         :type => "BUG",
         :content => "This should say it's a Ruby file",
+        :original_content => "# BUG: This should say it's a Ruby file",
         :file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
+        :original_file => 'spec/resources/sub_directory/another_ruby_file_with_todos.rb',
         :line => 2
       }
     ]

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'coveralls'
+Coveralls.wear!

data/todos_export.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
 
   spec.add_runtime_dependency "highline"
   spec.add_runtime_dependency "octokit"
   spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "system_timer"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: todos_export
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ryan Caught
@@ -15,13 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-17 00:00:00 -04:00
+date: 2013-06-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,12 +31,12 @@ dependencies:
         - 1
         - 3
         version: "1.3"
-  type: :development
-  version_requirements: *id001
+  name: bundler
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: rake
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -45,12 +45,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id002
+  name: rake
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -59,12 +59,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
-  version_requirements: *id003
+  name: rspec
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: highline
+  type: :development
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -73,12 +73,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id004
+  name: coveralls
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: octokit
+  type: :runtime
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -87,12 +87,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id005
+  name: highline
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
-  name: json
+  type: :runtime
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -101,12 +101,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id006
+  name: octokit
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
-  name: system_timer
+  type: :runtime
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -115,8 +115,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id007
+  name: json
+  requirement: *id007
 description: Export comment Todo's, Fixme's and Bug's from your code
 email: 
 - rcaught@gmail.com
@@ -128,6 +128,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -142,6 +143,7 @@ files:
 - spec/resources/ruby_file_with_todos.rb
 - spec/resources/ruby_file_without_todos.rb
 - spec/resources/sub_directory/another_ruby_file_with_todos.rb
+- spec/spec_helper.rb
 - todos_export.gemspec
 has_rdoc: true
 homepage: https://github.com/rcaught/todos_export
@@ -184,3 +186,4 @@ test_files:
 - spec/resources/ruby_file_with_todos.rb
 - spec/resources/ruby_file_without_todos.rb
 - spec/resources/sub_directory/another_ruby_file_with_todos.rb
+- spec/spec_helper.rb