note_tracker 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7363a355b02befe8556d4683c60128bb1e0329a
+  data.tar.gz: 4df89376943d2a2b331d0129a3901e43f6a04793
+SHA512:
+  metadata.gz: 3e501342a135411edb9a31056b51c707f5034bc4c479292dafc59f0cb91f3e22371c3b9ec366811608e74d046cd9f7e337bcf80ecd052a7093ea236542e67890
+  data.tar.gz: 9e556e89347c2657a33fc041a26f50e943fd71a1337366c944e32c06792ff32c255e8fa25bf5779333109665bc8a7022fda490ca036c500337a36057878be83b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alfonso Uceda Pompa
+
+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,31 @@
+# NoteTracker
+
+This gem provides the feature to track your notes with pivotal tracker
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'note_tracker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install note_tracker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/note_tracker/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task default: :test

data/lib/note_tracker.rb

@@ -0,0 +1,8 @@
+require "note_tracker/version"
+require "tracker_api"
+
+module NoteTracker
+  autoload :Client,                    'note_tracker/client'
+  autoload :SourceAnnotationExtractor, 'note_tracker/source_annotation_extractor'
+  autoload :Tracker,                   'note_tracker/tracker'
+end

data/lib/note_tracker/client.rb

@@ -0,0 +1,12 @@
+module NoteTracker
+  class Client
+    def initialize(options = {})
+      @tracker_token   = options.fetch(:tracker_token)
+      @tracker_project = options.fetch(:tracker_project)
+    end
+
+    def track(options = {})
+      Tracker.new(@tracker_token, @tracker_project, options).perform
+    end
+  end
+end

data/lib/note_tracker/source_annotation_extractor.rb

@@ -0,0 +1,134 @@
+# Class copied from [1] and modified to store pivotal tracker id
+#
+# [1]: https://github.com/rails/rails/blob/master/railties/lib/rails/source_annotation_extractor.rb
+module NoteTracker
+  class SourceAnnotationExtractor
+    class Annotation < Struct.new(:line, :tag, :story_id, :text)
+      def self.directories
+        @@directories ||= %w(app config db lib test) + (ENV['SOURCE_ANNOTATION_DIRECTORIES'] || '').split(',')
+      end
+
+      def self.extensions
+        @@extensions ||= {}
+      end
+
+      # Registers new Annotations File Extensions
+      #   SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
+      def self.register_extensions(*exts, &block)
+        extensions[/\.(#{exts.join("|")})$/] = block
+      end
+
+      register_extensions("builder", "rb", "rake", "yml", "yaml", "ruby") { |tag| /#\s*(\[#\d+\])?\s*(#{tag}):?\s*\s*(.*)$/ }
+      register_extensions("css", "js") { |tag| /\/\/\s*(\[#\d+\])?\s*(#{tag}):?\s*\s*(.*)$/ }
+      register_extensions("erb") { |tag| /<%\s*#\s*(\[#\d+\])?\s*(#{tag}):?\s*(.*?)\s*%>/ }
+
+      # Returns a representation of the annotation that looks like this:
+      #
+      #   [126] [TODO] This algorithm is simple and clearly correct, make it faster.
+      #
+      # If +options+ has a flag <tt>:tag</tt> the tag is shown as in the example above.
+      # Otherwise the string contains just line and text.
+      def to_s(options={})
+        s = "[#{line.to_s.rjust(options[:indent])}] "
+        s << "[#{tag}] " if options[:tag]
+        s << text
+      end
+
+      def trackered?
+        !!story_id
+      end
+    end
+
+    # Prints all annotations with tag +tag+ under the root directories +app+,
+    # +config+, +db+, +lib+, and +test+ (recursively).
+    #
+    # Additional directories may be added using a comma-delimited list set using
+    # <tt>ENV['SOURCE_ANNOTATION_DIRECTORIES']</tt>.
+    #
+    # Directories may also be explicitly set using the <tt>:dirs</tt> key in +options+.
+    #
+    #   SourceAnnotationExtractor.enumerate 'TODO|FIXME', dirs: %w(app lib), tag: true
+    #
+    # If +options+ has a <tt>:tag</tt> flag, it will be passed to each annotation's +to_s+.
+    #
+    # See <tt>#find_in</tt> for a list of file extensions that will be taken into account.
+    #
+    # This class method is the single entry point for the rake tasks.
+    def self.enumerate(tag, options={})
+      extractor = new(tag)
+      dirs = options.delete(:dirs) || Annotation.directories
+      extractor.display(extractor.find(dirs), options)
+    end
+
+    attr_reader :tag
+
+    def initialize(tag)
+      @tag = tag
+    end
+
+    # Returns a hash that maps filenames under +dirs+ (recursively) to arrays
+    # with their annotations.
+    def find(dirs)
+      dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
+    end
+
+    # Returns a hash that maps filenames under +dir+ (recursively) to arrays
+    # with their annotations. Only files with annotations are included. Files
+    # with extension +.builder+, +.rb+, +.erb+, +.haml+, +.slim+, +.css+,
+    # +.scss+, +.js+, +.coffee+, +.rake+, +.sass+ and +.less+
+    # are taken into account.
+    def find_in(dir)
+      results = {}
+      p dir
+      p ".. #{Dir.glob("#{dir}/*")}"
+      Dir.glob("#{dir}/*") do |item|
+        p item
+        next if File.basename(item)[0] == ?.
+
+        if File.directory?(item)
+          results.update(find_in(item))
+        else
+          extension = Annotation.extensions.detect do |regexp, _block|
+            regexp.match(item)
+          end
+
+          if extension
+            pattern = extension.last.call(tag)
+            results.update(extract_annotations_from(item, pattern)) if pattern
+          end
+        end
+      end
+
+      results
+    end
+
+    # If +file+ is the filename of a file that contains annotations this method returns
+    # a hash with a single entry that maps +file+ to an array of its annotations.
+    # Otherwise it returns an empty hash.
+    def extract_annotations_from(file, pattern)
+      lineno = 0
+      result = File.readlines(file).inject([]) do |list, line|
+        lineno += 1
+        next list unless line =~ pattern
+        tag = $2
+        text = $3
+        story_id = $1.to_s.scan(/\d+/).first
+        list << Annotation.new(lineno, tag, story_id, text)
+      end
+      result.empty? ? {} : { file => result }
+    end
+
+    # Prints the mapping from filenames to annotations in +results+ ordered by filename.
+    # The +options+ hash is passed to each annotation's +to_s+.
+    def display(results, options={})
+      options[:indent] = results.flat_map { |f, a| a.map(&:line) }.max.to_s.size
+      results.keys.sort.each do |file|
+        puts "#{file}:"
+        results[file].each do |note|
+          puts "  * #{note.to_s(options)}"
+        end
+        puts
+      end
+    end
+  end
+end

data/lib/note_tracker/tracker.rb

@@ -0,0 +1,51 @@
+require 'tempfile'
+require 'fileutils'
+
+module NoteTracker
+  class Tracker
+    def initialize(token, project, options = {})
+      @token = token
+      @project = project
+      @tags_to_track = options.fetch(:tags) { "OPTIMIZE|FIXME|TODO" }
+      @directories_to_track = options.fetch(:directories) { %w(.) }
+    end
+
+    def perform
+      results_annotation_extractor.each do |file, annotations|
+        temp_file = Tempfile.new('foo')
+
+        File.open(file, 'r') do |file|
+          file.each_line do |line|
+            annotation = annotations.detect { |annotation| annotation.line == file.lineno }
+            if annotation && !annotation.trackered?
+              story_id = create_story(annotation).id
+              line.gsub!("#{annotation.tag}","[##{story_id}] #{annotation.tag}")
+            end
+            temp_file.puts line
+          end
+        end
+
+        temp_file.close
+        FileUtils.mv(temp_file.path, file)
+      end
+    end
+
+    private
+
+    def tracker_client
+      @tracker_client ||= TrackerApi::Client.new(token: @token)
+    end
+
+    def tracker_project
+      @tracker_project ||= tracker_client.project(@project)
+    end
+
+    def create_story(annotation)
+      tracker_project.create_story(name: annotation.text)
+    end
+
+    def results_annotation_extractor
+      SourceAnnotationExtractor.new(@tags_to_track).find(@directories_to_track)
+    end
+  end
+end

data/lib/note_tracker/version.rb

@@ -0,0 +1,3 @@
+module NoteTracker
+  VERSION = "0.0.2"
+end

data/note_tracker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'note_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "note_tracker"
+  spec.version       = NoteTracker::VERSION
+  spec.authors       = ["Alfonso Uceda Pompa"]
+  spec.email         = ["uceda73@gmail.com"]
+  spec.summary       = %q{Track your notes with Pivotal tracker}
+  spec.description   = %q{This gem provides the feature to track your notes with pivotal tracker}
+  spec.homepage      = "https://github.com/AlfonsoUceda/note_tracker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "tracker_api"
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'minitest/byebug' if ENV['DEBUG']
+require 'minitest/autorun'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: note_tracker
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alfonso Uceda Pompa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: tracker_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides the feature to track your notes with pivotal tracker
+email:
+- uceda73@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/note_tracker.rb
+- lib/note_tracker/client.rb
+- lib/note_tracker/source_annotation_extractor.rb
+- lib/note_tracker/tracker.rb
+- lib/note_tracker/version.rb
+- note_tracker.gemspec
+- test/minitest_helper.rb
+homepage: https://github.com/AlfonsoUceda/note_tracker
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Track your notes with Pivotal tracker
+test_files:
+- test/minitest_helper.rb