locat 0.2.0 → 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30139bab3135e5869d5f033601a83cd95a5576e1
+  data.tar.gz: d47140e87ede5fe4bec6262035ce50c4fe85771d
+SHA512:
+  metadata.gz: 5a9e8bc7d8b8bb360690ab1489b66d618b213ea45a0891e2f4dc71d56ac63e4e03c21e1b4a82e3dc156753debf2590d8c5d0c327f12c80e0f6ea5e20b9ba861a
+  data.tar.gz: 20095f2ba61639db03bbfed6716dd6cacccee51d3288ae89c9fe7b4805c594d9deac1e0837f17bb5f2c3a0a8e945688d240eb08fcf58de06aa7e0b8506310c66

data/.index

@@ -0,0 +1,61 @@
+---
+revision: 2013
+type: ruby
+sources:
+- var
+authors:
+- name: Trans
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- name: grit
+- name: ansi
+- name: json
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - test
+  development: true
+  name: qed
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/locat
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/locat
+  label: Source Code
+- type: docs
+  uri: http://rubydoc.info/gems/locat/frames
+  label: Documentation
+- type: bugs
+  uri: http://github.com/rubyworks/locat/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/locat.git
+categories: []
+copyrights:
+- holder: Rubyworks
+  year: '2011'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+name: locat
+title: LOCat
+summary: Lines of Code Attache
+created: '2011-07-07'
+description: LOCat is a customizable Lines-Of-Code analysis tool. LOC might not be
+  the most useful metric in the universe, but it still provides useful information
+  and can be a lot of fun.
+version: 0.2.3
+date: '2014-01-13'

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,6 +1,18 @@
-= RELEASE HISTORY
+# RELEASE HISTORY
 
-== 0.2.0 | 2011-11-04
+## 0.2.3 | 2014-01-13
+
+This is a minor release that deals with a couple of minor issues,
+albeit the issue with a broken grit dependency can cause locat to crash.
+
+Changes:
+
+* If Grit fails then gracely skip git timeline analysis.
+* Don't try to create logging directory if it already exists.
+* Fix missing YAML requirement.
+
+
+## 0.2.0 | 2011-11-04
 
 This release upgrades the HighCharts javascript dependency a notch
 to v2.1.6, and provides a default configuration when none is provided
@@ -12,7 +24,7 @@ Changes:
 * Update HighCharts dependency to 2.1.6.
 
 
-== 0.1.2 | 2011-07-11
+## 0.1.2 | 2011-07-11
 
 Doh. Can I not write one line of code with a bug creeping
 into it! Any how, this release just fixes a typo in the CLI
@@ -24,7 +36,7 @@ Changes:
 * Set default encoding.
 
 
-== 0.1.1 | 2011-07-10
+## 0.1.1 | 2011-07-10
 
 This release fixes a few issues reported by friendly cats.
 It also adds a new command line option to set the document
@@ -38,7 +50,7 @@ Changes:
 * Add grit dependency. #2
 
 
-== 0.1.0 | 2011-07-08 | The Cat's Meow
+## 0.1.0 | 2011-07-08 | The Cat's Meow
 
 This is the first release of LOCat a 
 fancy LOC analysis tool.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+BSD-2-Clause License
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY Thomas Sawyer ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Thomas Sawyer OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/{README.rdoc → README.md}

@@ -1,19 +1,19 @@
-= LOCat
+# LOCat
 
-{Homepage}[http://rubyworks.github.com/locat] |
-{Development}[http://github.com/rubyworks/locat] |
-{Issue Tracker}[http://github.com/rubyworks/locat/issues] |
-{Mailing List}[http://groups.google.com/group/rubyworks-mailinglist]
+[Homepage](http://rubyworks.github.com/locat) |
+[Development](http://github.com/rubyworks/locat) |
+[Issue Tracker](http://github.com/rubyworks/locat/issues) |
+[Mailing List](http://groups.google.com/group/rubyworks-mailinglist)
 
-{<img src="http://travis-ci.org/rubyworks/locat.png" />}[http://travis-ci.org/rubyworks/locat]
+[<img src="http://travis-ci.org/rubyworks/locat.png" />](http://travis-ci.org/rubyworks/locat)
 
 
-== DESCRIPTION
+## DESCRIPTION
 
 LOCat is a fancy Lines-Of-Code analysis tool.
 
 
-== SYNOPSIS
+## SYNOPSIS
 
 Define a `.locat` Ruby script in your project, e.g.
 
@@ -43,12 +43,14 @@ Then run `locat`, e.g.
 
     $ locat -o locat.html
 
+The config file can also be located at `etc/locat.rb` or `config/locat.rb`.
 
-== COPYRIGHT
 
-Copyright (c) 2011 Thomas Sawyer, Rubyworks
+## COPYRIGHT
+
+Copyright (c) 2011 Rubyworks
 
 BSD 2-Clause License
 
-See COPYING.rdoc for details.
+See LICENSE.md for details.
 

data/lib/locat/command.rb

@@ -1,5 +1,7 @@
 module LOCat
 
+  require 'yaml'
+
   #
   def self.cli(*argv)
     options = {}
@@ -81,7 +83,10 @@ module LOCat
 
     #
     def default_config_files
-      Dir['.locat{,/*.rb}'].select{ |f| File.file?(f) }
+      files = []
+      files.concat Dir['.locat{,.rb}']
+      files.concat Dir['{etc/,config/}locat.rb']
+      files.select{ |f| File.file?(f) }
     end
 
     #
@@ -94,14 +99,14 @@ module LOCat
       @counter ||= Counter.new(matcher, :files=>files)
     end
 
-    # Access to .ruby metadata. This only really cares about
-    # the `title` field (at this point). If no `.ruby` file
+    # Access to .index metadata. This only really cares about
+    # the `title` field (at this point). If no `.index` file
     # is found, the title is set to the basename of the current
     # working directory.
     def metadata
       @metadata ||= (
-        if File.file?('.ruby')
-          data = YAML.load(File.new('.ruby'))
+        if File.file?('.index')
+          data = YAML.load(File.new('.index'))
         else
           data = {}
         end
@@ -133,7 +138,8 @@ module LOCat
     #
     def save_file(text)
       if output
-        FileUtils.mkdir_p(File.dirname(output))
+        dir = File.dirname(output)
+        FileUtils.mkdir_p(dir) unless File.directory?(dir)
         File.open(File.join(output), 'w') do |f|
           f << text
         end

data/lib/locat/counter.rb

@@ -121,14 +121,16 @@ module LOCat
 
     #
     def scm
-      if scm?
+      return nil unless scm?
+      begin
         gitloc.timeline_table
-      else
+      rescue
+        warn "Can't generate git timeline. Skipping."
         nil
       end
     end
 
-    private
+  private
 
     # Resolve file glob.
     def resolve_files(pattern)

data/lib/locat/gitloc.rb

@@ -42,7 +42,7 @@ module LOCat
 
     #
     def title
-      "'#{repo.head.name}' branch JavaScript LOC #{@per_day ? 'per day' : 'per commit'}"
+      "'#{repo.head.name}' branch LOC #{@per_day ? 'per day' : 'per commit'}"
     end
 
     # Count lines by groups.

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: locat
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.3
 platform: ruby
 authors:
 - Trans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-04 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &26222540 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *26222540
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &26255180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *26255180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &26254680 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *26254680
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &26254160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *26254160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &26253640 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *26253640
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: LOCat is a customizable Lines-Of-Code analysis tool. LOC might not be
   the most useful metric in the universe, but it still provides useful information
   and can be a lot of fun.
@@ -75,12 +89,12 @@ executables:
 - locat
 extensions: []
 extra_rdoc_files:
-- HISTORY.rdoc
-- README.rdoc
-- QED.rdoc
-- COPYING.rdoc
+- LICENSE.txt
+- README.md
+- HISTORY.md
+- DEMO.md
 files:
-- .ruby
+- .index
 - bin/locat
 - lib/locat/command.rb
 - lib/locat/counter.rb
@@ -91,37 +105,33 @@ files:
 - lib/locat/template/javascript.js
 - lib/locat/template.rb
 - lib/locat.rb
-- spec/applique/locat.rb
-- spec/fixtures/.locat
-- spec/fixtures/lib/example.rb
-- spec/testrun.rdoc
-- HISTORY.rdoc
-- README.rdoc
-- QED.rdoc
-- COPYING.rdoc
+- README.md
+- HISTORY.md
+- DEMO.md
+- LICENSE.txt
 homepage: http://rubyworks.github.com/locat
 licenses:
 - BSD-2-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Lines of Code Attache
 test_files: []
+has_rdoc: 

data/.ruby

@@ -1,50 +0,0 @@
----
-source:
-- meta
-authors:
-- name: Trans
-  email: transfire@gmail.com
-copyrights:
-- holder: Rubyworks
-  year: '2011'
-  license: BSD-2-Clause
-replacements: []
-alternatives: []
-requirements:
-- name: grit
-- name: ansi
-- name: json
-- name: detroit
-  groups:
-  - build
-  development: true
-- name: qed
-  groups:
-  - test
-  development: true
-dependencies: []
-conflicts: []
-repositories:
-- uri: git://github.com/rubyworks/locat.git
-  scm: git
-  name: upstream
-resources:
-  home: http://rubyworks.github.com/locat
-  code: http://github.com/rubyworks/locat
-  docs: http://rubydoc.info/gems/locat/frames
-  bugs: http://github.com/rubyworks/locat/issues
-  mail: http://groups.google.com/group/rubyworks-mailinglist
-extra: {}
-load_path:
-- lib
-revision: 0
-created: '2011-07-07'
-summary: Lines of Code Attache
-title: LOCat
-version: 0.2.0
-name: locat
-description: LOCat is a customizable Lines-Of-Code analysis tool. LOC might not be
-  the most useful metric in the universe, but it still provides useful information
-  and can be a lot of fun.
-organization: Rubyworks
-date: '2011-11-04'

data/COPYING.rdoc

@@ -1,30 +0,0 @@
-= COPYRIGHT NOTICES
-
-== LOCat
-
-Copyright:: (c) 2011 Thomas Sawyer, Rubyworks
-License:: BSD-2-Clause
-Website:: http://rubyworks.github.com/locat
-
-    Copyright (c) 2011 Thomas Sawyer. All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without modification, are
-    permitted provided that the following conditions are met:
-
-       1. Redistributions of source code must retain the above copyright notice, this list of
-          conditions and the following disclaimer.
-
-       2. Redistributions in binary form must reproduce the above copyright notice, this list
-          of conditions and the following disclaimer in the documentation and/or other materials
-          provided with the distribution.
-
-    THIS SOFTWARE IS PROVIDED BY Thomas Sawyer ``AS IS'' AND ANY EXPRESS OR IMPLIED
-    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-    FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Thomas Sawyer OR
-    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-    ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

data/spec/applique/locat.rb

@@ -1,12 +0,0 @@
-require 'locat'
-require 'fileutils'
-
-When 'Given an example ruby project' do
-  FileUtils.rm 'locat.html' if File.exist?('locat.html')
-  FileUtils.cp_r(File.dirname(__FILE__) + '/../fixtures/.', '.')
-end
-
-When 'with a `.locat` file' do |text|
-  File.open('.locat', 'w'){ |f| f << text }
-end
-

data/spec/fixtures/.locat

@@ -1,18 +0,0 @@
-
-match 'lib/**.rb' do |file, line|
-  case line
-  when /^\s*#/
-    'Comment'
-  when /^\s*$/
-    'Blank'
-  else
-    'Code'
-  end
-end
-
-match 'test/**.rb' do |file, line|
-  unless line.strip.empty?
-    'Test'
-  end
-end
-

data/spec/fixtures/lib/example.rb

@@ -1,7 +0,0 @@
-# Just an example
-class Example
-  # example method
-  def self.example
-    puts "Surprise! It's an example!"
-  end  
-end

data/spec/testrun.rdoc

@@ -1,21 +0,0 @@
-== Test Run
-
-Given an example ruby project with a `.locat` file:
-
-  match 'lib/**.rb' do |file, line|
-    case line
-    when /^\s*#/
-      'Comment'
-    when /^\s*$/
-      'Blank'
-    else
-      'Code'
-    end
-  end
-
-Running the locat command should produce the expected HTML file.
-
-  LOCat.cli('--output', 'locat.html')
-
-  File.assert.exist?('locat.html')
-