jfish 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1930af7168069fdc3a67df278ebbe62a0e7406dc
+  data.tar.gz: fdd9e5ba56058a725ded25566eee10b726f4692a
+SHA512:
+  metadata.gz: d0c7ebb90b65ad306d107b9e8bf487c13419656a6a2e3eddeace03a16e0cbb5386b8c523d39b2c97e04760c6d9951a0b72888bdfcebf5b13d8cfc11ccd9d7599
+  data.tar.gz: d8ea80696f67485fedca8d334cce0b9c332afbebcc9d92a996b4fb0fe65077180873f99a4931ca41af7b82bab37b610670573ecd7310f1f3b1c0e68f129666cc

data/.document

@@ -0,0 +1,3 @@
+lib/**/*.rb
+- 
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2007-2010, Michael Granger. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* 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.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER 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.md

@@ -0,0 +1,57 @@
+![jfish logo](https://github.com/jeanlescure/jfish/raw/master/lib/template/jfish/images/logo.png)
+
+# JFish Rdoc 4.0.0+ Generator
+
+This is a complete replacement for the default HTML generator for Rdoc 4.0.0
+
+It was forked from https://github.com/ged/darkfish and modified to look a little greener and meaner.
+
+## Getting Started
+
+You can install it via RubyGems:
+
+  `$ gem install jfish`
+
+## Usage
+
+Specify from your Rakefile in an RDocTask:
+
+    require 'rdoc/task'
+    Rake::RDocTask.new do |rdoc|
+    
+      require 'jfish' #=> THIS IS IMPORTANT
+      
+      version = File.exist?('VERSION') ? File.read('VERSION') : ""
+      
+      rdoc.rdoc_dir = 'rdoc'
+      
+      rdoc.generator = 'jfish' #=> THIS IS IMPORTANT TOO
+      
+      rdoc.title = "hipster_sql_to_hbase #{version}"
+      rdoc.rdoc_files.include('README.rdoc')
+      rdoc.rdoc_files.include('lib/**/*.rb').exclude(/lib\/adapter/,/lib\/datatype_extras.rb/)
+    end
+  
+  
+That's it. JFish will automatically register itself to RDoc when required so that all you have to do is set it as the default generator.
+
+The important parts from the above code to add to your task are these:
+
+  `require 'jfish'`
+  
+and
+  
+  `rdoc.generator = 'jfish'`
+
+Once that's done, just call your rake task like so: `$ rake rdoc`
+
+## Logo
+
+In order to customize your rdoc with your logo simply replace the following path (relative to your generated 'rdoc' folder root):
+
+  `images/logo.png`
+
+## License
+
+See the LICENSE file included with the distribution for copyright and licensing details.
+

data/README.rdoc

@@ -0,0 +1,19 @@
+= jfish
+
+Description goes here.
+
+== Contributing to jfish
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Jean Lescure. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/jfish.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "jfish"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jean Lescure"]
+  s.date = "2014-02-27"
+  s.description = "This RDoc Generator was forked from RDoc's own JFish template and made into a Gem for easy consumption."
+  s.email = "jeanmlescure@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = Dir.glob("lib/**/*") + %w(.document Gemfile LICENSE LICENSE README.md Rakefile VERSION jfish.gemspec)
+  s.homepage = "http://github.com/jeanlescure/jfish"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "RDoc Generator based on JFish"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+    else
+      s.add_dependency(%q<rdoc>, ["~> 4.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+    end
+  else
+    s.add_dependency(%q<rdoc>, ["~> 4.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+  end
+end