index_html 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9fe1b61b2b205fb5a038dc97cbc381d133bfe78
-  data.tar.gz: 2a99fd50389fe228666b1129d807bd279e3a2e30
+  metadata.gz: 0dc0506496e64e1987a946e2ca3007d086c6429c
+  data.tar.gz: 4f574f9ef646d37aad326e8d54645c1aa4bd18d5
 SHA512:
-  metadata.gz: 0bfcb95a89184d513f8118005e053aec89d6c8045b66f7b0a719c3ca3271a3dda19d5580975c442bab58b499514e8740c27062032eee685162a8177faeaed235
-  data.tar.gz: cbd9a3ec2bdaf0e2b091dac447564f90c39561d4889d57e8833253b0ffd4bb1d0586a4e082ae8d5f74e52557e42a8a9860744e446990216155e9cd0da5eba3f1
+  metadata.gz: 06ebabd731486b63c72af5d73f3dad7800aa5df06b9b599fec82e9c5366706f353efcf11657bb35342ef53c72b5e0f57be15fc5c72ba94dfaf07276b8fff9239
+  data.tar.gz: 6eeae24f691eb6b957dda0b08993dcce9b22d2be982288e2a7f69b1eb9ea3a3da6200a15097cd6a6c2e92969a7b322717c41fdb680258b59e719dad0cebf013f

data/.gitignore

@@ -15,7 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-
 # custom generated files
 index.html
-rubocop-todo.yml
+.ruby-version

data/.rubocop.yml

@@ -1,10 +1,96 @@
-# This is the configuration used to check the rubocop source code.
 AllCops:
   Include:
-    - '**/Rakefile'
-    - '**/Gemfile'
-    - lib/**/*
+    - Gemfile
+    - Rakefile
     - bin/*
-  Exclude:
-    - .rubocop.yml
-inherit_from: rubocop-todo.yml
+    - index_html.gemspec
+    - lib/**/*.rb
+    - spec/index_html/**/*.rb
+    - spec/spec_helper.rb
+# Avoid long parameter lists
+ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+MethodLength:
+  CountComments: false
+  Max: 15
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 4
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessModifierIndentation:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Enabled: false
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Enforce Ruby 1.8-compatible hash syntax
+HashSyntax:
+  Enabled: true
+
+# No spaces inside hash literals
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Allow dots at the end of lines
+DotPosition:
+  Enabled: false
+
+# Don't require magic comment at the top of every file
+Encoding:
+  Enabled: false
+
+# Enforce outdenting of access modifiers (i.e. public, private, protected)
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+# Align ends correctly
+EndAlignment:
+  AlignWith: variable
+
+# Indentation of when/else
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  IndentOneStep: false
+
+DoubleNegation:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOGS.md

@@ -1,5 +1,11 @@
 ### Changelogs
 
+#### 0.1.3
+
+- Simplify the CLI usage
+- Cleanup style with rubocop
+- Add `coveralls` badges
+
 #### 0.1.2
 
 - First release based on the [Semantic Versioning][] convention.

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in file_indexer.gemspec
 gemspec
+
+gem "coveralls", require: false

data/README.md

@@ -3,10 +3,14 @@
 [![Gem Version](https://badge.fury.io/rb/index_html.svg)][gem]
 [![Dependency Status](https://gemnasium.com/agilecreativity/index_html.png)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/agilecreativity/index_html.png)][codeclimate]
+[![Build Status](https://secure.travis-ci.org/agilecreativity/index_html.png)][travis-ci]
+[![Coverage Status](https://coveralls.io/repos/agilecreativity/index_html/badge.png)][coveralls]
 
 [gem]: http://badge.fury.io/rb/index_html
 [gemnasium]: https://gemnasium.com/agilecreativity/index_html
 [codeclimate]: https://codeclimate.com/github/agilecreativity/index_html
+[travis-ci]: http://travis-ci.org/agilecreativity/index_html
+[coveralls]: https://coveralls.io/r/agilecreativity/index_html
 
 Quickly generate the index.html files based on your simple criteria.
 
@@ -37,10 +41,10 @@ that have the specific word 'Android' in the title you could perhap try somethin
 ```sh
 gem install index_html
 cd ~/Dropbox/ebooks/
-index_html generate --base-dir . \
-                    --exts epub pdf mobi  \
-                    --inc-words android \
-                    --recursive
+index_html --base-dir . \
+           --exts epub pdf mobi  \
+           --inc-words android \
+           --recursive
 ```
 
 ### Help/Usage:
@@ -80,7 +84,7 @@ This will generate the file `index.html` that you can open from your favourite b
 - Sample list of files from a given directory
 
 ```shell
-$index_html generate --base-dir=spec/fixtures --exts=rb java --recursive
+$index_html --base-dir=spec/fixtures --exts=rb java --recursive
 ```
 The output file `index.html` should be generated with something like
 
@@ -105,7 +109,7 @@ The output file `index.html` should be generated with something like
 - Run with simple prefix option
 
 ```shell
-index_html generate --base-dir spec/fixtures --exts rb java --recursive --prefix http://localhost
+index_html --base-dir spec/fixtures --exts rb java --recursive --prefix http://localhost
 ```
 
 The output file `index.html` should be something like

data/Rakefile

@@ -1,15 +1,25 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec
 
 task :pry do
-  require 'pry'
-  require 'awesome_print'
-  require 'index_html'
+  require "pry"
+  require "awesome_print"
+  require "index_html"
   include IndexHtml
   ARGV.clear
   Pry.start
 end
+
+require "rubocop/rake_task"
+desc "Run RuboCop on the lib directory"
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ["lib/**/*.rb"]
+  # only show the files with failures
+  task.formatters = ["files"]
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/bin/index_html

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
-require 'code_lister'
-require_relative '../lib/index_html'
+require "code_lister"
+require_relative "../lib/index_html"
 include IndexHtml
-IndexHtml::CLI.start(ARGV)
+if ARGV.empty?
+  IndexHtml::CLI.start(%w[usage])
+else
+  IndexHtml::CLI.start(%w[generate].concat(ARGV))
+end

data/index_html.gemspec

@@ -1,38 +1,38 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'index_html/version'
+require "index_html/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'index_html'
+  spec.name          = "index_html"
   spec.version       = IndexHtml::VERSION
-  spec.authors       = ['Burin Choomnuan']
-  spec.email         = ['agilecreativity@gmail.com']
-  spec.description   = %q{Generate the index.html from list of files}
-  spec.summary       = %q{Generate simple index.html from list of files based on simple criteria}
-  spec.homepage      = 'https://github.com/agilecreativity/index_html'
-  spec.license       = 'MIT'
-  spec.files         = Dir.glob('{bin,lib}/**/*') + %w(Gemfile
+  spec.authors       = ["Burin Choomnuan"]
+  spec.email         = ["agilecreativity@gmail.com"]
+  spec.description   = %q(Generate the index.html from list of files)
+  spec.summary       = %q(Generate simple index.html from list of files based on simple criteria)
+  spec.homepage      = "https://github.com/agilecreativity/index_html"
+  spec.license       = "MIT"
+  spec.files         = Dir.glob("{bin,lib}/**/*") + %w[Gemfile
                                                        Rakefile
                                                        index_html.gemspec
                                                        README.md
                                                        CHANGELOGS.md
                                                        LICENSE
                                                        .rubocop.yml
-                                                       .gitignore
-                                                       rubocop-todo.yml)
+                                                       .gitignore]
   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_runtime_dependency 'thor', '~> 0.19'
-  spec.add_runtime_dependency 'agile_utils', '~> 0.1'
-  spec.add_runtime_dependency 'code_lister', '~> 0.1'
-  spec.add_development_dependency 'awesome_print', '~> 1.2'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'fuubar', '~> 1.3'
-  spec.add_development_dependency 'guard-rspec', '~> 4.2'
-  spec.add_development_dependency 'pry', '~> 0.9'
-  spec.add_development_dependency 'rake', '~> 10.3'
-  spec.add_development_dependency 'rspec', '~> 2.14'
-  spec.add_development_dependency 'rubocop', '~> 0.20'
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "agile_utils", "~> 0.1"
+  spec.add_runtime_dependency "code_lister", "~> 0.1"
+  spec.add_development_dependency "awesome_print", "~> 1.2"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "fuubar", "~> 1.3"
+  spec.add_development_dependency "guard-rspec", "~> 4.2"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rubocop", "~> 0.20"
+  spec.add_development_dependency "coveralls", "~> 0.7"
 end

data/lib/index_html/cli.rb

@@ -1,10 +1,10 @@
-require 'thor'
-require 'agile_utils'
-require_relative '../index_html'
-
+require "thor"
+require "agile_utils"
+require_relative "../index_html"
 module IndexHtml
   class CLI < Thor
-    desc 'generate', 'Generate the index.html base on simple criteria'
+    # rubocop:disable AmbiguousOperator, LineLength
+    desc "generate", "Generate the index.html base on simple criteria"
     # Common shared options
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::EXTS
@@ -17,19 +17,19 @@ module IndexHtml
 
     # specific to this action only
     method_option :prefix,
-                  aliases: '-p',
-                  desc: 'Prefix string to the URL',
-                  default: '.'
+                  aliases: "-p",
+                  desc: "Prefix string to the URL",
+                  default: "."
     method_option :indent,
-                  aliases: '-d',
-                  desc: 'Indentation to each list item in the output',
+                  aliases: "-d",
+                  desc: "Indentation to each list item in the output",
                   type: :numeric,
                   default: 6
     method_option :output,
-                  aliases: '-o',
-                  desc: 'Output file name',
+                  aliases: "-o",
+                  desc: "Output file name",
                   type: :string,
-                  default: 'index.html'
+                  default: "index.html"
     def generate
       opts = options.symbolize_keys
       if opts[:version]
@@ -39,11 +39,11 @@ module IndexHtml
       run(opts)
     end
 
-    desc 'usage', 'Display help screen'
+    desc "usage", "Display help screen"
     def usage
       puts <<-EOS
 Usage:
-  index_html generate
+  index_html
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
@@ -67,10 +67,11 @@ Options:
 Generate the index.html base on simple criteria
       EOS
     end
+    # rubocop:enable AmbiguousOperator, LineLength
 
     default_task :usage
 
-    private
+  private
 
     def run(options = {})
       files = CodeLister.files options || []

data/lib/index_html/version.rb

@@ -1,3 +1,3 @@
 module IndexHtml
-  VERSION = '0.1.2'
+  VERSION = "0.1.3"
 end

data/lib/index_html.rb

@@ -1,13 +1,13 @@
-require 'uri'
-require 'code_lister'
-require_relative './index_html/version'
-require_relative './index_html/cli'
+require "uri"
+require "code_lister"
+require_relative "./index_html/version"
+require_relative "./index_html/cli"
 module IndexHtml
   CustomError = Class.new(StandardError)
   class << self
     # Create html links to list of files
     def htmlify(file_list, args = {})
-      header = <<-END.gsub(/^\s+\|/, '')
+      header = <<-END.gsub(/^\s+\|/, "")
         |<html>
         |<title>File Listing</title>
         |<header>File List</header>
@@ -15,20 +15,20 @@ module IndexHtml
         |    <ol>
         END
 
-      footer = <<-END.gsub(/^\s+\|/, '')
+      footer = <<-END.gsub(/^\s+\|/, "")
         |    </ol>
         |  </body>
         |</html>
         END
 
-      prefix = args.fetch(:prefix, '.')
+      prefix = args.fetch(:prefix, ".")
       indent = args.fetch(:indent, 6)
-      output = args.fetch(:output, 'index.html')
+      output = args.fetch(:output, "index.html")
 
-      File.open(output, 'w') do |f|
+      File.open(output, "w") do |f|
         f.write(header)
         links = make_links file_list, prefix: prefix, base_dir: args[:base_dir]
-        links.each { |i| f.write("#{' ' * indent}#{i}\n") }
+        links.each { |i| f.write("#{" " * indent}#{i}\n") }
         f.write(footer)
       end
     end
@@ -58,15 +58,15 @@ module IndexHtml
     #
     # @return [Array<String>] the list of valid <li> tags
     def make_links(file_list, args)
-      prefix = args.fetch(:prefix, '.')
+      prefix = args.fetch(:prefix, ".")
       result = []
 
       file_list.each do |i|
-        path = File.absolute_path(i).gsub(Dir.pwd, '')
+        path = File.absolute_path(i).gsub(Dir.pwd, "")
         if prefix
           link =  %Q(<li><a href="#{prefix}#{path}" target='_blank'>#{prefix}#{path}</li>)
         else
-          link =  %Q(<li><a href=".#{path}" target='_blank'>#{path.gsub(/^\//, '')}</li>)
+          link =  %Q(<li><a href=".#{path}" target='_blank'>#{path.gsub(/^\//, "")}</li>)
         end
         result << link
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: index_html
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Generate the index.html from list of files
 email:
 - agilecreativity@gmail.com
@@ -184,7 +198,6 @@ files:
 - lib/index_html.rb
 - lib/index_html/cli.rb
 - lib/index_html/version.rb
-- rubocop-todo.yml
 homepage: https://github.com/agilecreativity/index_html
 licenses:
 - MIT

data/rubocop-todo.yml

@@ -1,67 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-05-09 23:59:42 +1000 using RuboCop version 0.21.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 8
-AmbiguousOperator:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Blocks:
-  Enabled: true
-
-# Offense count: 3
-Documentation:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-EmptyLinesAroundBody:
-  Enabled: true
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-HashSyntax:
-  Enabled: true
-
-# Offense count: 2
-# Cop supports --auto-correct.
-LeadingCommentSpace:
-  Enabled: true
-
-# Offense count: 40
-LineLength:
-  Max: 182
-
-# Offense count: 3
-# Configuration parameters: CountComments.
-MethodLength:
-  Max: 21
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-PercentLiteralDelimiters:
-  Enabled: true
-
-# Offense count: 1
-# Cop supports --auto-correct.
-SpaceAfterComma:
-  Enabled: true
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-SpaceBeforeBlockBraces:
-  Enabled: true
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-StringLiterals:
-  Enabled: true