RubyGems - html_notes - Versions diffs - 0.1.0 - Mend

Files changed (15) hide show

data/.gitignore +7 -0
data/.rspec +1 -0
data/Gemfile +4 -0
data/README.rdoc +19 -0
data/Rakefile +12 -0
data/assets/template.html.erb +97 -0
data/bin/html_notes +4 -0
data/html_notes.gemspec +25 -0
data/lib/html_notes.rb +27 -0
data/lib/html_notes/parser.rb +10 -0
data/lib/html_notes/version.rb +8 -0
data/spec/html_notes/parser_spec.rb +11 -0
data/spec/html_notes_spec.rb +7 -0
data/spec/spec_helper.rb +7 -0
metadata +93 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/*
+docs

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --color --format documentation

data/Gemfile ADDED Viewed

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

data/README.rdoc ADDED Viewed

@@ -0,0 +1,19 @@
+= HTML Notes
+== Installing
+  $ gem install html_notes
+== Usage
+  $ html_notes
+== License
+"THE BEER-WARE LICENSE":
+As long as you retain this notice you
+can do whatever you want with this stuff. If we meet some day, and you think
+this stuff is worth it, you can buy me a beer.

data/Rakefile ADDED Viewed

@@ -0,0 +1,12 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+require 'rdoc/task'
+RDoc::Task.new do |t|
+  t.rdoc_dir = "docs"
+  t.title    = "HTML Notes"
+  t.options << "-m" << "README.rdoc"
+end

data/assets/template.html.erb ADDED Viewed

@@ -0,0 +1,97 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <meta charset='UTF-8' />
+  <title>Output of HTML Notes </title>
+  <style type="text/css">
+      body {
+          color: #333;
+          background: #eee;
+          padding: 0 20px;
+      }
+      h1 {
+          color: #4E4E4E;
+      }
+      p {
+          margin: 5px 0;
+      }
+      table {
+          background: white;
+          border: 1px solid #666;
+          border-collapse: collapse;
+          margin: 10px 0;
+          font-size: 14px;
+      }
+      table th, table td {
+          padding: 4px;
+          border: 1px solid #D0D0D0;
+      }
+      table th {
+          background-color: #DFC;
+          color: #337022;
+      }
+      table td.filename {
+          color: #ED1556;
+      }
+      table tr:hover {
+          background-color: #FFFFC0;
+      }
+      ul {
+          clear: both;
+          display: inline-block;
+          padding: 0;
+          margin: 0;
+      }
+      ul li {
+          list-style: none;
+          float: left;
+      }
+  </style>
+</head>
+<body>
+<h1>html_notes output</h1>
+<p>
+  <% if @rows.empty? %>
+      No notations found.
+  <% else %>
+      Found <%= @rows.size %> notations.
+  <% end %>
+</p>
+<ul>
+  <% @notation_names.each do |notation| %>
+      <li><input type="checkbox" value="<%= notation.strip %>" /><%= notation.strip %></li>
+  <% end %>
+</ul>
+<table>
+  <tr>
+    <th>Filename</th>
+    <th>Line Number</th>
+    <th>Notation</th>
+    <th>Text</th>
+  </tr>
+  <% @rows.each do |row| %>
+      <tr class="<%= row.notation.strip %>">
+        <td><%= row.file %></td>
+        <td><%= row.line %></td>
+        <td><%= row.notation %></td>
+        <td><%= row.text %></td>
+      </tr>
+  <% end %>
+</table>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"></script>
+<script type="text/javascript">
+    $(function() {
+        $('ul li').show();
+        $('input[type=checkbox]').prop('checked', true).click(function() {
+            if ($(this).attr('checked')) {
+                $(this).prop('checked', true);
+                $('.'+$(this).val()).show();
+            } else {
+                $(this).prop('checked', false);
+                $('.'+$(this).val()).hide();
+            }
+        });
+    });
+</script>
+</body>
+</html>

data/bin/html_notes ADDED Viewed

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "html_notes"
+HTMLNotes.start

data/html_notes.gemspec ADDED Viewed

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "html_notes/version"
+Gem::Specification.new do |s|
+  s.name        = "html_notes"
+  s.version     = HTMLNotes::Version::STRING
+  s.authors     = ["Rafael Macedo"]
+  s.email       = ["macedo.rafaelfernandes@gmail.com"]
+  s.homepage    = "http://github.com/rafaelmacedo/html_notes"
+  s.summary     = "An interface html to view annotations in source files"
+  s.description = s.summary
+  s.rubyforge_project = "html_notes"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  # specify any dependencies here; for example:
+  s.add_dependency "notes", "~> 0.0.2"
+  s.add_dependency "erubis"
+  s.add_development_dependency "rspec", "~> 2.6.0"
+end

data/lib/html_notes.rb ADDED Viewed

@@ -0,0 +1,27 @@
+module HTMLNotes
+  autoload :Version, "html_notes/version"
+  autoload :Parser, "html_notes/parser"
+  class << self
+    def start
+      @rows = `notes`.split("\n").inject([]) do |rows, line|
+        rows << HTMLNotes::Parser.new(line)
+      end
+      output_html
+    end
+    def output_html
+      require 'erubis'
+      template = File.read(File.join(File.dirname(__FILE__), "..", "assets", "template.html.erb"))
+      File.open("notes.html", "w+") do |file|
+        eruby = Erubis::Eruby.new(template)
+        file.puts eruby.evaluate(:rows => @rows, :notation_names => notation_names)
+      end
+    end
+    def notation_names
+      @rows.map(&:notation).uniq
+    end
+  end
+end

data/lib/html_notes/parser.rb ADDED Viewed

@@ -0,0 +1,10 @@
+module HTMLNotes
+  class Parser
+    attr_reader :file, :line, :notation, :text
+    def initialize(line)
+      @file, @line, @notation, @text = line.split(':')
+    end
+  end
+end

data/lib/html_notes/version.rb ADDED Viewed

@@ -0,0 +1,8 @@
+module HTMLNotes
+  module Version
+    MAJOR = '0'
+    MINOR = '1'
+    PATCH = '0'
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/spec/html_notes/parser_spec.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require "spec_helper"
+describe HTMLNotes::Parser do
+  it "should split the result from notes gem in attributes" do
+    @parser = HTMLNotes::Parser.new('features/step_definitions/web_steps.rb:76: TODO: Add support for checkbox, select or option')
+    @parser.file.should == 'features/step_definitions/web_steps.rb'
+    @parser.line.should == '76'
+    @parser.notation.should  == ' TODO'
+    @parser.text.should  ==  ' Add support for checkbox, select or option'
+  end
+end

data/spec/html_notes_spec.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require "spec_helper"
+describe HTMLNotes do
+  it "has a version" do
+    HTMLNotes::Version::STRING.should match(/^\d+\.\d+\.\d+$/)
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,7 @@
+ENV["BUNDLE_GEMFILE"] = File.dirname(__FILE__) + "/../Gemfile"
+require "bundler/setup"
+Bundler.setup
+require "html_notes"

metadata ADDED Viewed

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: html_notes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease:
+platform: ruby
+authors:
+- Rafael Macedo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-10-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: notes
+  requirement: &80323960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *80323960
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: &80501930 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *80501930
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &80804680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *80804680
+description: An interface html to view annotations in source files
+email:
+- macedo.rafaelfernandes@gmail.com
+executables:
+- html_notes
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- assets/template.html.erb
+- bin/html_notes
+- html_notes.gemspec
+- lib/html_notes.rb
+- lib/html_notes/parser.rb
+- lib/html_notes/version.rb
+- spec/html_notes/parser_spec.rb
+- spec/html_notes_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rafaelmacedo/html_notes
+licenses: []
+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: html_notes
+rubygems_version: 1.8.10
+signing_key:
+specification_version: 3
+summary: An interface html to view annotations in source files
+test_files: []

html_notes 0.1.0