github_readme_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87dbb96c173ee8d90a0c6e127ffb064573d9c46d
+  data.tar.gz: 0e1335d9cd409ba04ddf435e868dfdabe1292e72
+SHA512:
+  metadata.gz: cce92862532059ffab62f1754eecca5fd645b987cfc06372af23d36eb3658d116e7f41efa3b5ce0d47447f6fb492c9af2e97306366fc11787f05afc98bb0081a
+  data.tar.gz: bd4b6f98c9976a07544548fc8cecb859e7ddb9d83995167f8d8de8d993ef088c993057889ba3bd8deab717c7f467c99b796e1b202663c0160e6b1809f6d2534d

data/README.md

@@ -0,0 +1,34 @@
+Github README Generator
+=======================
+
+`github-readme-generator` lets you generate a `README.md` file simply.
+
+# Example
+
+```ruby
+# Rakefile
+require 'github_readme_generator/task'
+
+GitHubReadmeGenerator::RakeTask.new :readme do |config|
+  config.title = 'FreeRADIUS Puppet module'  # Dynamic using github lib?
+  config.badges = {
+    :puppetforge_version => {
+      :badge   => :puppetforge,
+      :type    => 'v',
+      :user    => 'raphink',    # Dynamic from metadata.json?
+      :project => 'freeradius', # Dynamic from metadata.json?
+    },
+    :puppetforge_downloads => {
+      :badge   => :puppetforge,
+      :type    => 'dt',
+      :user    => 'raphink',    # Dynamic from metadata.json?
+      :project => 'freeradius', # Dynamic from metadata.json?
+    },
+    :travis => {
+      :badge   => :travis,
+      :user    => 'raphink', # Dynamic from git
+      :project => 'puppet-freeradius', # Dynamic from git?
+    },
+  }
+end
+```

data/github_readme_generator.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name               = "github_readme_generator"
+  spec.version            = '0.1.0'
+
+  spec.required_ruby_version     = ">= 1.9.3"
+  spec.authors = ["Raphaël Pinson"]
+  spec.email = "raphael.pinson@camptocamp.com"
+  spec.date = `date +"%Y-%m-%d"`.strip!
+  spec.summary = "Generate README.md automatically"
+  spec.description = "Generate README.md automatically"
+  spec.homepage = "https://github.com/raphink/github-readme-generator"
+  spec.license       = "Apache 2.0"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/lib/github_readme_generator/task.rb

@@ -0,0 +1,76 @@
+require "rake"
+require "rake/tasklib"
+
+module GitHubReadmeGenerator
+  class RakeTask < ::Rake::TaskLib
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    OPTIONS = %w( title badges )
+
+    OPTIONS.each do |o|
+      attr_accessor o.to_sym
+    end
+
+    # Public: Initialise a new GitHubChangelogGenerator::RakeTask.
+    #
+    # Example
+    #
+    #   GitHubChangelogGenerator::RakeTask.new
+    def initialize(*args, &task_block)
+      @name = args.shift || :readme
+
+      define(args, &task_block)
+    end
+
+    def define(args, &task_block)
+      desc "Generate a README.md"
+
+      task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
+
+      # clear any (auto-)pre-existing task
+      Rake::Task[@name].clear if Rake::Task.task_defined?(@name)
+
+      task @name do
+        out = @title
+        out << "\n"
+        out << "=" * @title.length
+        out << "\n\n"
+
+        # Badges
+        @badges.each do |k, v|
+          case v[:badge]
+          when :puppetforge
+            case v[:type]
+            when 'v'
+              title = v[:title] || 'Puppet Forge Version'
+            when 'dt'
+              title = v[:title] || 'Puppet Forge Downloads'
+            else
+              title = v[:title] || 'Puppet Forge'
+            end
+            img = "https://img.shields.io/puppetforge/#{v[:type]}/#{v[:user]}/#{v[:project]}.svg"
+            link = "https://forge.puppetlabs.com/#{v[:user]}/#{v[:project]}"
+            out << "[![#{title}](#{img})](#{link})\n"
+          when :travis
+            title = v[:title] || 'Build Status'
+            img = "https://img.shields.io/travis/#{v[:user]}/#{v[:project]}.svg"
+            link = "https://travis-ci.org/#{v[:user]}/#{v[:project]}"
+            out << "[![#{title}](#{img})](#{link})\n"
+          else
+            fail "Unknown badge type '#{v[:badge]}'"
+          end
+        end
+
+        # Usage from examples
+        out << "\n## Usage\n\n"
+        Dir.glob('examples/*').each do |e|
+          content = File.read(e).gsub(/^#\s*/, '')
+          out << "\n#{content}\n"
+        end
+
+        File.open('README.md', 'w').puts(out)
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: github_readme_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Raphaël Pinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies: []
+description: Generate README.md automatically
+email: raphael.pinson@camptocamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- github_readme_generator.gemspec
+- lib/github_readme_generator/task.rb
+homepage: https://github.com/raphink/github-readme-generator
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Generate README.md automatically
+test_files: []
+has_rdoc: