totrello 0.2.03 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTNjOGEzMzY1NTg4ZDE3Y2VhNWVhM2RhMmY3ZjIyMWNmOTc3YTU4NA==
+    MjNlMjZiY2FhN2JhNjliYzJkMjM2MDc3YTA4ZDM4ZDNlMWNmOTIwOQ==
   data.tar.gz: !binary |-
-    MGE2NGJhZjIyMjc4YjlkNGUwMjhmYmFlYTk0ODE4ZDNhNGMxYzhiNQ==
+    MjZmNmM5YmUzZTc2OTI2MWRkZmI0YzBmYjdmNjUwYjc2YTU1YTY2OQ==
 SHA512:
   metadata.gz: !binary |-
-    OTc0NDVkOTJlNzdhMDRkZmZiZWEwYTQwZmM5MTEzNzFiNjRjMDgwNTc4ZGM5
-    NTZhNDMzNjdkMjQyZWQxMjc0ZDQ0MGU0Y2IyYmQzM2RlYzg1NmY4YjdmMGNk
-    Y2FkOGUxNTA0YmNiNWM2MWE0NDMyODcyNTBlN2EyOGE2YjJjZjE=
+    Y2M5MGU3OThmOWI0ZGUxNjFlNjJjZDA4ZTczZmU5YmZhYWYyODc4YzkzZjNh
+    NjJhYzg3ZGJjZTU1ZGU0YTcwNTYyOTJiYmZlODI0ODViY2M1MGExN2FlOGZj
+    NDNmNDU0ZmE1MmUwNmFjZWFjZjIwODhlN2Q5NTA4MzVhMDJkZjY=
   data.tar.gz: !binary |-
-    N2RlYzBjM2I0ZDQ5NGMzMmQ5Y2EzOTE3NDYwYjk2YjM4MjA5NWVjZTg4MGMx
-    ZmUwYzAzMjgyNGIyN2VmMDg1YjYyNTYyNTNmYWExOTZlN2IxNGQ4NGQ2OTZk
-    MGVkODdhOTViYzkzM2M4YjQ5YzRhZjg5N2JmMWJhMGZmMjE3Mzg=
+    OWJiYTk4YjE1ZDMyYTFhYzZkM2FhYWZjMWM2ZGE0OTkxMDI4MmYzZTlmMDdk
+    MTM2MDRmMGU2NmQzODhlODcyYThlM2Q0MTAyN2NhYmFhNzc4ZmMwMWZjNjRi
+    NzQ0OTZmNDllMmQ0OTc3OTFhNGUzODU1NDNkZTI1MWFjYjVjY2Y=

data/.totrello.yml

@@ -2,7 +2,10 @@ totrello:
           project_name: 'ToTrello'
           board_name: 'ToTrello'
           default_list: 'To Do'
+          todo_types: ['TODO', '#TODO', '#TODO:', 'TODO:', 'FIXME', '#FIXME', '#FIXME:', 'FIXME:']
+          comment_style: ['#','//']
+          file_types: ['.rb','.yml']
           excludes: [
                     'pkg/',
                     'bin/',
-                   ]
+                   ]

data/README.md

@@ -30,13 +30,16 @@ Generate your TRELLO_MEMBER_TOKEN at: https://trello.com/1/authorize?key=[TRELLO
     $ export TRELLO_DEVELOPER_PUBLIC_KEY='[Your key here]'
     $ export TRELLO_MEMBER_TOKEN='[Your key here]'
 
-### Creating a .totrello.yml file:
+### Creating a .totrello.yml file (Must be in root directory):
 
 The ToTrello yml file allows you to customize the way ToTrello functions:
 + Project_name : The name of the project (i.e. ToTrello)
-+ board_name : The Trello board you want to post to
++ board_name   : The Trello board you want to post to
 + default_list : The list you want your new todo items to post to
-+ excludes : The files or directories you want to exclude
++ todo_types   : The types of todo items you want to capture
++ comment_style: How comments appear in your file types
++ file_types   : Types of files you want to include in the search
++ excludes     : The files or directories you want to exclude
 
 #### Sample file:
 
@@ -44,6 +47,9 @@ The ToTrello yml file allows you to customize the way ToTrello functions:
               project_name: 'ToTrello'
               board_name: 'ToTrello'
               default_list: 'To Do'
+              todo_types: ['TODO', '#TODO', '#TODO:', 'TODO:', 'FIXME', '#FIXME', '#FIXME:', 'FIXME:']
+              comment_style: ['#','//']
+              file_types: ['.rb','.yml']
               excludes: [
                         'pkg/',
                         'bin/',

data/lib/to_do_find.rb

@@ -4,19 +4,19 @@ class ToDoFind
 
   # This will search a given directory
   #
-  def search(directory, excludes_dirs)
+  def search(directory, excludes_dirs, todo_styles, file_types, comment_styles)
     files_to_search = []
 
     directory ||= Dir.pwd
 
     todos= {directory: directory.split('/').last, :todo_list=>[] }
 
-    files_to_search = exclude_folders(get_folders(directory), Array(excludes_dirs))
+    files_to_search = exclude_folders(get_folders(directory, file_types), Array(excludes_dirs))
 
 
     files_to_search.each do |my_text_file|
 
-      found_todo = find_todo(my_text_file)
+      found_todo = find_todo(my_text_file, todo_styles, comment_styles)
 
 
       if found_todo
@@ -30,10 +30,16 @@ class ToDoFind
     todos
   end
 
-  def get_folders(directory)
+  def get_folders(directory, file_types)
+
+    files = []
     directory ||= Dir.pwd
-    rbfiles = File.join("#{directory}/**", "*.*rb")
-    Dir.glob(rbfiles)
+
+    file_types.each do |ft|
+      file = File.join("#{directory}/**", "*#{ft.to_s}")
+      files.concat(Dir.glob(file))
+    end
+    files
   end
 
   def exclude_folders(file_array, excludes_array)
@@ -43,47 +49,46 @@ class ToDoFind
     file_array
   end
 
-  def find_todo(file)
-    todo_styles = ['TODO', '#TODO', '#TODO:', 'TODO:']
+  def find_todo(file, todo_styles, comment_styles)
     @out = []
     code_lines = File.readlines(file)
-
-    return @out unless code_lines.grep('/TODO/' || '/todo/')
-
     code_lines= code_lines.map.with_index { |x,i| {:todo => x, :location => i + 1}}
 
     todo_styles.each do |tds|
       @out.concat((code_lines.find_all { |i| is_todo?(i[:todo], (tds))}))
     end
 
-    clean_todos(@out).sort_by { |hsh| hsh[:todo] }
+    clean_todos(@out, todo_styles, comment_styles).sort_by { |hsh| hsh[:todo] }
   end
 
   private
-  def clean_todos(todo_array)
-    todo_array.each do |found_todos|
-      found_todos[:todo].gsub!('TODO:', '')
-      found_todos[:todo].gsub!('TODO', '')
-      found_todos[:todo].gsub!('#', '')
-      found_todos[:todo].chomp!
-      found_todos[:todo].lstrip!
+    def clean_todos(todo_array, todo_styles, comment_styles)
+      todo_array.each do |found_todos|
+        todo_styles.each do |tds|
+          found_todos[:todo].gsub!(tds,'')
+        end
+        comment_styles.each do |cms|
+          found_todos[:todo].gsub!(cms,'')
+        end
+        found_todos[:todo].gsub!(':','')
+        found_todos[:todo].chomp!
+        found_todos[:todo].lstrip!
+      end
+
     end
 
-  end
+    def is_todo?( string, test_string )
+      begin
+        location = string.split(' ').index test_string
+        if location.nil?
+          return false
+        else
+          return true
+      end
+      rescue
+        false
+      end
 
-  private
-  def is_todo?( string, test_string )
-    begin
-      location = string.split(' ').index test_string
-      if location.nil?
-        return false
-      else
-        return true
     end
-    rescue
-      false
-    end
-
-  end
 
 end

data/lib/totrello/version.rb

@@ -1,3 +1,3 @@
 module Totrello
-  VERSION = "0.2.03"
+  VERSION = "0.3.0"
 end

data/lib/totrello.rb

@@ -56,45 +56,43 @@ module Totrello
     end
 
     private
-    def create_cards(board)
+      def create_cards(board)
 
 
-      processes = []
-      todos = get_todos
+        processes = []
+        todos = get_todos
 
-      puts 'Talking to Trello, this is the longest part...'
+        puts 'Talking to Trello, this is the longest part...'
 
-      todos[:todo_list].each do |tdl|
-        tdl[:todos].each do |td|
-          unless td == ''
-            processes.append(fork {create_trello_card(board, @config[:default_list], td, tdl[:file])})
+        todos[:todo_list].each do |tdl|
+          tdl[:todos].each do |td|
+            unless td == ''
+              processes.append(fork {create_trello_card(board, @config[:default_list], td, tdl[:file])})
 
+            end
           end
         end
-      end
-
-      process_manager(processes)
-    end
-
-    private
-    def process_manager(processes)
-      processes.each {|pro| Process.waitpid(pro)}
-    end
-
-    private
-    def get_todos
-      puts 'Finding your todo items... '
-      todo = ToDoFind.new
-      todos = todo.search(@directory,Array( @config[:excludes]))
-      puts "Woot! We've got'em"
-      todos
-    end
-
 
+        process_manager(processes)
+      end
 
+      def process_manager(processes)
+        processes.each {|pro| Process.waitpid(pro)}
+      end
 
+      def get_todos
+        puts 'Finding your todo items... '
+        todo = ToDoFind.new
+        todos = todo.search(@directory,
+                            Array( @config[:excludes]),
+                            Array( @config[:todo_types]),
+                            Array( @config[:file_types]),
+                            Array( @config[:comment_styles]))
+        puts "Woot! We've got'em"
+        todos
+      end
 
-  end
 
+    end
 
 end

data/lib/totrello_config.rb

@@ -5,6 +5,9 @@ class TotrelloConfig
   @board_name
   @default_list
   @excludes
+  @todo_types
+  @file_types
+  @comment_style
 
   def initialize(directory)
     read_config(directory)
@@ -16,29 +19,35 @@ class TotrelloConfig
         :project_name => @project_name,
         :board_name   => @board_name,
         :default_list => @default_list,
-        :excludes     => @excludes
+        :excludes     => @excludes,
+        :todo_types   => @todo_types,
+        :file_types   => @file_types,
+        :comment_style   => @comment_style
     }
   end
 
   private
-  def read_config(directory)
+    def read_config(directory)
 
-    rbfiles = File.join("#{directory}/**", ".totrello.yml")
-    trello_yml = Dir.glob(rbfiles)[0]
+      totrello_config_file = File.join("#{directory}/", ".totrello.yml")
+      trello_yml = Dir.glob(totrello_config_file)[0]
 
-    unless trello_yml.nil?
-        config = YAML.load_file(trello_yml )
-        config['totrello'].each { |key, value| instance_variable_set("@#{key}", value) }
-    end
+      unless trello_yml.nil?
+          puts "Found yml file file: #{trello_yml}"
+          config = YAML.load_file(trello_yml )
+          config['totrello'].each { |key, value| instance_variable_set("@#{key}", value) }
+      end
 
-  end
+    end
 
-  private
-  def defaults(directory)
-    @project_name ||=  directory.split('/').last
-    @board_name   ||= directory.split('/').last
-    @default_list ||= 'To Do'
-    @excludes     ||= Array(nil)
-  end
+    def defaults(directory)
+      @project_name  ||=  directory.split('/').last
+      @board_name    ||= directory.split('/').last
+      @default_list  ||= 'To Do'
+      @excludes      ||= Array(nil)
+      @todo_types    ||= Array(['TODO', '#TODO', '#TODO:', 'TODO:'])
+      @file_types    ||= Array(['.rb','.erb'])
+      @comment_style ||= Array(['#'])
+    end
 
 end

data/lib/trello_creator.rb

@@ -9,7 +9,6 @@ class TrelloCreator
   end
 
   def create_card(board, name, description, list_name)
-    puts description
     list_names = ['To Do', 'Doing', 'Done']
     unless card_exists?(board, list_names, name)
       card = Trello::Card.create(name: name, list_id: self.find_list(board, list_name), desc: description)

data/test/to_do_find_spec.rb

@@ -6,8 +6,19 @@ describe 'ToDoFind' do
   describe 'find_todo_items' do
     it 'returns a hash of todo items from a directory'do
       todo = ToDoFind.new
-      todos = todo.search("#{Dir.pwd}/test/test_data",nil)
-      expected = {:directory => "test_data", :todo_list => [{:file => "/testing.rb", :todos => [{:todo => "test1", :location => 1}, {:todo => "test2", :location => 2}, {:todo => "test3", :location => 3}, {:todo => "test4}", :location => 4}, {:todo => "test5", :location => 5}, {:todo => "test6", :location => 6}]}]}
+      todos = todo.search("#{Dir.pwd}/test/test_data",
+                          nil,
+                          Array(['TODO', '#TODO', '#TODO:', 'TODO:']),
+                          Array(['.rb','.erb']),
+                          Array(['#']))
+      expected = {:directory => "test_data",
+                  :todo_list => [{:file => "/testing.rb",
+                                  :todos => [{:todo => "test1", :location => 1},
+                                             {:todo => "test2", :location => 2},
+                                             {:todo => "test3", :location => 3},
+                                             {:todo => "test4}", :location => 4},
+                                             {:todo => "test5", :location => 5},
+                                             {:todo => "test6", :location => 6}]}]}
       expect(todos).to include(expected)
     end
 
@@ -16,7 +27,11 @@ describe 'ToDoFind' do
   describe 'formatted_data' do
     it "Should have a string for the todo and an Int for the locaion" do
       todo = ToDoFind.new
-      todos = todo.search("#{Dir.pwd}/test/test_data", nil)
+      todos = todo.search("#{Dir.pwd}/test/test_data",
+                          nil,
+                          Array(['TODO', '#TODO', '#TODO:', 'TODO:']),
+                          Array(['.rb','.erb']),
+                          Array(['#']))
 
       todos[:todo_list].each do |tdl|
         tdl[:todos].each do |td|
@@ -32,7 +47,7 @@ describe 'ToDoFind' do
   describe 'get_folders' do
     it "Should return an array of files and folders" do
       todo = ToDoFind.new
-      files = todo.get_folders("#{Dir.pwd}/test/test_data")
+      files = todo.get_folders("#{Dir.pwd}/test/test_data",Array(['.rb','.erb']))
       expect(files).to be_a(Array)
     end
 
@@ -41,7 +56,7 @@ describe 'ToDoFind' do
   describe 'exclude_folders' do
     it "Should return an array an empty array" do
       todo = ToDoFind.new
-      files = todo.get_folders("#{Dir.pwd}/test/test_data")
+      files =todo.get_folders("#{Dir.pwd}/test/test_data",Array(['.rb','.erb']))
       files = todo.exclude_folders(files, Array(['test']))
       expect(files).to be_a(Array)
       expect(files).to match_array([])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: totrello
 version: !ruby/object:Gem::Version
-  version: 0.2.03
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Teeter