readmexec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01edcab452f73170e54d3d90d8c9282f86e0decc
+  data.tar.gz: 5586006cdf76b777216a441bf4d157691519d239
+SHA512:
+  metadata.gz: d0ad1b29b8b543cdeb512d9efc431459f89a616ea3f140dc64ec6f4af3d5c62736c03182716a1d05e5c3f32106d8b0f9d796a37fcf9ca69518b7e7869830dd1a
+  data.tar.gz: 3cefb1a52081e60150af716e01c148dd9b057a78212e40f211af73f81a45383e2bd4c7a5fe7e947c9334d41122e8aa490d648cb70622ac00b80ced37accf5537

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+readmexec/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Wojciech Mach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# Readmexec
+
+Readmexec grabs commands from your README and runs them.
+
+The idea here is to make README executable and verifiable since this is the only way to make it up to date.
+
+## Example
+
+```sh
+mkdir -p readmexec && cp README.md readmexec/
+```
+
+and run readmexec. By default it will just output commands it's going to execute:
+
+```sh
+cd readmexec && readmexec
+```
+
+Run `readmexec -e` to run them.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :test do
+  sh "ruby test/*.rb"
+end
+
+task :default => :test

data/bin/readmexec

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+BEGIN_REGEX = /\A```(.*)/
+END_REGEX = /\A```$/
+
+execute = ARGV[0] == "-e"
+
+Block = Struct.new :type, :content do
+  def self.for(buffer)
+    type = buffer.first.match(BEGIN_REGEX)[1]
+    content = buffer[1..-2].join("\n")
+    new(type, content)
+  end
+end
+
+lines = File.readlines("README.md")
+buffer = []
+blocks = []
+
+lines.each do |line|
+  if line =~ BEGIN_REGEX .. line =~ END_REGEX
+    buffer << line
+  end
+
+  if line =~ END_REGEX
+    blocks << Block.for(buffer)
+    buffer = []
+  end
+end
+
+blocks.each do |block|
+  if execute
+    puts `#{block.content}`
+  else
+    puts block.content
+  end
+end

data/lib/readmexec/version.rb

@@ -0,0 +1,3 @@
+module Readmexec
+  VERSION = "0.0.1"
+end

data/lib/readmexec.rb

@@ -0,0 +1,5 @@
+require "readmexec/version"
+
+module Readmexec
+  # Your code goes here...
+end

data/readmexec.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readmexec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "readmexec"
+  spec.version       = Readmexec::VERSION
+  spec.authors       = ["Wojtek Mach"]
+  spec.email         = ["wojtek@wojtekmach.pl"]
+  spec.summary       = %q{Readmexec grabs commands from your README and runs them.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/test/readmexec_test.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+
+describe "Readmexec" do
+  it "executes commands from the README" do
+    system "rm -rf readmexec"
+
+    `./bin/readmexec`.must_equal <<-end.gsub(/^\ {6}/, '')
+      mkdir -p readmexec && cp README.md readmexec/
+      cd readmexec && readmexec
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: readmexec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wojtek Mach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- wojtek@wojtekmach.pl
+executables:
+- readmexec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/readmexec
+- lib/readmexec.rb
+- lib/readmexec/version.rb
+- readmexec.gemspec
+- test/readmexec_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Readmexec grabs commands from your README and runs them.
+test_files:
+- test/readmexec_test.rb