viewmd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3444da61b127641f4673be0fdc72ad9f57b63914
+  data.tar.gz: 3087b5294d9b83cf39e158eb08122b7d8ed19a40
+SHA512:
+  metadata.gz: 23d7a657f5bf47924a98a34351b3d63d39d71035ab08e09992672e47f8cce14ff4a1e4e0c372b1f9495870e79a0f7b726e6fe6392d45a45982fb54dff4b95dd9
+  data.tar.gz: 50444cc0fcfad27692da5477171bb3d1bd600d90694cb2db305c6ec14fc9ce5a17208d622e43ff109759e66ffb152002844067a48b7c3139f3374cfabab0e7ad

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.env
+.rspec
+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
+**/.DS_Store

data/CONTRIBUTORS.md

@@ -0,0 +1 @@
+* Andrey Pronin <moonfly.msk@gmail.com> aka moonfly (https://github.com/moonfly)

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2014 [CONTRIBUTORS.md](https://github.com/moonfly/viewmd/master/CONTRIBUTORS.md)
+
+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,56 @@
+# Viewmd
+
+Viewmd is a command line tool for viewing your Markdown files (e.g. README.md) in your local browser. Uses GitHub Markup parser, so the result should look very close to what you'd see on Github if you put the file there.
+
+I guess, we all hate committing files with bugs. In case of Markdown files, like README.md, it's possible to make some little mistake while editing the file (e.g. forget the trailing triple-backticks) and end up with an incorrectly formatted file checked in to your repository. Seeing it only on GitHub already, for example, and having to do another little fix & commit just to fix this little formatting mistake seens like an untidy process to me. Thus I created this really simple command-line tool to see how the file would look like *before* committing. 
+
+It's really simple and doesn't try to catch all errors (e.g. trying to open a non-existent file).
+
+Please note that I tested it on MacOS only. If you use other OS in your development environment, it may not work. It actually uses [Launchy](https://github.com/copiousfreetime/launchy) for opening files, so it will all depend on Launchy's support for your OS.
+
+## Installation
+
+If you prefer managing your tools through your application's Gemfile, add this line there:
+
+```ruby
+gem 'viewmd', group: :development, require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or, better yet, as with all generic dev-tools, install the gem yourself environment-wide as:
+
+    $ gem install viewmd
+
+## Usage
+
+    $ viewmd <filename>
+
+## Versioning
+
+Semantic versioning (http://semver.org/spec/v2.0.0.html) is used. 
+
+For a version number MAJOR.MINOR.PATCH, unless MAJOR is 0:
+
+1. MAJOR version is incremented when incompatible API changes are made,
+2. MINOR version is incremented when functionality is added in a backwards-compatible manner, 
+3. PATCH version is incremented when backwards-compatible bug fixes are made.
+
+Major version "zero" (0.y.z) is for initial development. Anything may change at any time. 
+The public API should not be considered stable. 
+
+## Dependencies
+
+* [github-markup](https://github.com/github/markup)
+* [redcarpet](https://github.com/vmg/redcarpet)
+* [launchy](https://github.com/copiousfreetime/launchy)
+
+## Contributing
+
+1. Fork it ( https://github.com/moonfly/viewmd/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/viewmd

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'viewmd'
+
+if ARGV.count == 1 && File.exists?(ARGV.first)
+  Viewmd::view(ARGV.first)
+else
+  puts "Viewmd (ver #{Viewmd::VERSION}): view Markdown (GitHub Markup) file in a browser"
+  puts "    Usage: viewmd <md-file>"
+end

data/lib/viewmd.rb

@@ -0,0 +1,17 @@
+require 'viewmd/version'
+require 'github/markup'
+require 'launchy'
+require 'tempfile'
+
+module Viewmd
+  def self.view(name)
+    Tempfile.create(['viewmd','.htm'],Dir.tmpdir,File::CREAT|File::TRUNC|File::RDWR, 0600) do |f|
+      f << GitHub::Markup.render(name, File.read(name))
+      f.flush
+      Launchy.open(f.path) 
+      # joining the launchy thread doesn't help to wait for browser to close before deleting the file
+      # so, let's just wait a little
+      sleep 2
+    end
+  end
+end

data/lib/viewmd/version.rb

@@ -0,0 +1,3 @@
+module Viewmd
+  VERSION = "0.1.0"
+end

data/viewmd.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'viewmd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "viewmd"
+  spec.version       = Viewmd::VERSION
+  spec.authors       = ['moonfly (Andrey Pronin)']
+  spec.email         = ['moonfly.msk@gmail.com']
+  spec.summary       = %q{Command line tool for viewing Markdown files (GitHub Markup) in a browser}
+  spec.description   = %q{Command line tool for viewing Markdown files (GitHub Markup) in a browser}
+  spec.homepage      = 'https://github.com/moonfly/viewmd'
+  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.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.rdoc_options = ['--charset=UTF-8']
+  spec.extra_rdoc_files = %w[README.md CONTRIBUTORS.md LICENSE.md]
+  
+  spec.add_dependency 'github-markup', '>= 1.3'
+  spec.add_dependency 'launchy', '>= 2.4'
+  spec.add_dependency 'redcarpet', '>= 3.1'
+  
+  spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: viewmd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- moonfly (Andrey Pronin)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Command line tool for viewing Markdown files (GitHub Markup) in a browser
+email:
+- moonfly.msk@gmail.com
+executables:
+- viewmd
+extensions: []
+extra_rdoc_files:
+- README.md
+- CONTRIBUTORS.md
+- LICENSE.md
+files:
+- ".gitignore"
+- CONTRIBUTORS.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/viewmd
+- lib/viewmd.rb
+- lib/viewmd/version.rb
+- viewmd.gemspec
+homepage: https://github.com/moonfly/viewmd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+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: Command line tool for viewing Markdown files (GitHub Markup) in a browser
+test_files: []