markwiki 0.0.1a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2999bcbd6e948645cc7eaf852fe0c9fa13966c4b
+  data.tar.gz: 73bfede8e7a323771fb28769ffb1365d5f59ec3e
+SHA512:
+  metadata.gz: 71d4d72fc5f34c54ac8cc2140b5763d9a8847d5d7b416552aca9b49d7174b3049c6dea6ef34ef7bf5e296c708558baa3f0a24dbdf467332303a3ba1bc399a89d
+  data.tar.gz: 059085372570a2c448d5c19476a4fa7e28f94bb951215c108537a32ad1af272102f80f729c11774f2ed62806d94ba045acf3cb1bd46afa4f1562bb89bd0e1f33

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bryce Davis
+
+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,54 @@
+# Markwiki
+
+Markwiki is a Ruby gem designed to ease the development and maintenance of locally designed static sites using Markdown. Too often, at least for me, static site generators aren't intuitive to use, aren't focused for simple static sites (not blogs), or most often don't support GitHub flavoured Markdown (GFM).
+
+Markwiki is different in that it is a tool written by me, for me. However, it may be useful for you if you want a simple static site with GFM. In fact, the ideal workflow with Markwiki is:
+
+    Create a site with markwiki --init <NAME>
+    Write website stuff (Markdown, CSS (SASS?), and JS)
+    Compile and upload to your server with markwiki --launch
+
+Simple, eh?
+
+## Installation
+
+**NOTE:** Markwiki is still is pre-alpha. Don't have high expectations, or really any expectations at all.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'markwiki'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install markwiki
+
+## Usage
+
+```bash
+# SIMPLE USAGE
+Usage: markwiki [options]
+    -i <NAME>, --init <NAME>         Create a new Markwiki site
+    -v, --version                    Show the Markwiki version number
+    -h, --help                       Display this help menu
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mahimahi42/markwiki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "markwiki"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/markwiki

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# @author Bryce Davis <me@bryceadavis.com>
+# For command line option parsing
+require 'optparse'
+# Our gem's code
+require 'markwiki'
+
+module Markwiki
+	# A wrapper class for Markwiki's command line interface
+	class CLI
+		def self.start_cli
+			# A hash of parameters passed on to the CLI
+			options = {
+				:name => nil
+			}
+
+			# Define our available options
+			opts_parser = OptionParser.new do |opts|
+				opts.banner = "Usage: markwiki [options]"
+
+				# Initialize a new Markwiki site
+				opts.on("-i <NAME>", "--init <NAME>", "Create a new Markwiki site") do |name|
+					options[:name] = name
+				end
+
+				# Display the current version number
+				opts.on("-v", "--version", "Show the Markwiki version number") do
+					puts "Markwiki v#{Markwiki::VERSION}"
+					exit
+				end
+
+				# Display the help menu
+				opts.on("-h", "--help", "Display this help menu") do
+					puts opts
+					exit
+				end
+			end
+
+			# Parse the command line options
+			begin
+				opts_parser.parse!
+			rescue OptionParser::MissingArgument => e
+				puts "ERROR: Missing site name"
+				exit
+			end
+		end
+	end
+end
+
+Markwiki::CLI.start_cli

data/lib/markwiki.rb

@@ -0,0 +1,8 @@
+# @author Bryce Davis <me@bryceadavis.com>
+require "markwiki/version"
+require "markwiki/init"
+
+# Main driver for Markwiki
+module Markwiki
+  # Your code goes here...
+end

data/lib/markwiki/init.rb

@@ -0,0 +1,91 @@
+# @author Bryce Davis <me@bryceadavis.com>
+require 'json' # For JSON parsing
+
+module Markwiki
+    # The default Markwiki skeleton, to be converted to JSON.
+    # Custom skeletons/configurations can be defined as Ruby Hashes
+    # or JSON
+    CONFIG = {
+        "files" => ["index.html", ".markwiki.cfg"],
+        "css" => {
+            "dir_name" => "css",
+            "files" => ["styles.css"]
+        },
+        "js" => {
+            "dir_name" => "js",
+            "files" => ["scripts.js"]
+        },
+        "img" => {
+            "dir_name" => "img",
+            "files" => []
+        }
+    }
+
+    # Wrapper class for Markwiki initialization
+    class Init
+        # @todo Finish site initialization
+        def self.init_site(site_name)
+            
+        end
+
+        # Generate a JSON String representation of a Markwiki
+        # site.
+        #
+        # @return [String] the Markwiki configuration as a JSON String
+        def self.generate_json_config
+            Markwiki::CONFIG.to_json
+        end
+
+        # Generate a prettified JSON String representation of a
+        # Markwiki site.
+        #
+        # @return [String] the Markwiki configuration as a JSON String
+        def self.generate_pretty_json_config
+            JSON.pretty_generate Markwiki::CONFIG
+        end
+
+        # Get a Hash representation of a default Markwiki
+        # configuration
+        #
+        # @return [Hash] the default Markwiki configuration
+        def self.default_config
+            self.generate_config
+        end
+
+        # Get a Hash representation of an arbitrary Markwiki
+        # configuration
+        #
+        # @param files [Array<String>] an Array of top-level filenames
+        # @param css [String] the name of the CSS folder
+        # @param css_files [Array<String>] an Array of CSS files
+        # @param js [String] the name of the JavaScript folder
+        # @param js_files [Array<String>] an Array of JavaScript files
+        # @param img [String] the name of the images folder
+        # @param img_files [Array<String>] an Array of image files
+        # @return [Hash] a new Markwiki configuration Hash
+        def self.generate_config(
+            files: ["index.html"],
+            css: "css",
+            css_files: ["styles.css"],
+            js: "js",
+            js_files: ["scripts.js"],
+            img: "img",
+            img_files: [])
+            {
+                "files".to_s => files + [".markwiki.cfg"],
+                "css".to_s => {
+                    "dir_name" => css,
+                    "files" => css_files
+                },
+                "js".to_s => {
+                    "dir_name" => js,
+                    "files" => js_files
+                },
+                "img".to_s => {
+                    "dir_name" => img,
+                    "files" => img_files
+                }
+            }
+        end
+    end
+end

data/lib/markwiki/version.rb

@@ -0,0 +1,5 @@
+# @author Bryce Davis <me@bryceadavis.com>
+module Markwiki
+    # Current Markwiki version number
+    VERSION = "0.0.1a"
+end

data/markwiki.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markwiki/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "markwiki"
+  spec.version       = Markwiki::VERSION
+  spec.authors       = ["Bryce Davis"]
+  spec.email         = ["me@bryceadavis.com"]
+
+  spec.summary       = %q{Ruby utility for managing wiki-like sites with Markdown.}
+  spec.description   = <<-EOF
+    Markwiki is a Ruby gem designed to ease the development and maintenance of 
+    locally designed static sites using Markdown. Too often, at least for me, 
+    static site generators aren't intuitive to use, aren't focused for simple 
+    static sites (not blogs), or most often don't support GitHub 
+    flavoured Markdown (GFM).
+    
+    Markwiki is different in that it is a tool written by me, for me. However, 
+    it may be useful for you if you want a simple static site with GFM.
+  EOF
+  spec.homepage      = "https://github.com/mahimahi42/markwiki"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 0'
+  spec.add_development_dependency "yard", '~> 0'
+  
+  spec.add_runtime_dependency "json", '~> 0'
+end

data/static/.markwiki.cfg

@@ -0,0 +1,15 @@
+---
+files:
+- index.html
+- ".markwiki.cfg"
+css:
+  dir_name: css
+  files:
+  - styles.css
+js:
+  dir_name: js
+  files:
+  - scripts.js
+img:
+  dir_name: img
+  files: []

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: markwiki
+version: !ruby/object:Gem::Version
+  version: 0.0.1a
+platform: ruby
+authors:
+- Bryce Davis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: yard
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    Markwiki is a Ruby gem designed to ease the development and maintenance
+  of \n    locally designed static sites using Markdown. Too often, at least for me,
+  \n    static site generators aren't intuitive to use, aren't focused for simple
+  \n    static sites (not blogs), or most often don't support GitHub \n    flavoured
+  Markdown (GFM).\n    \n    Markwiki is different in that it is a tool written by
+  me, for me. However, \n    it may be useful for you if you want a simple static
+  site with GFM.\n"
+email:
+- me@bryceadavis.com
+executables:
+- markwiki
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/markwiki
+- lib/markwiki.rb
+- lib/markwiki/init.rb
+- lib/markwiki/version.rb
+- markwiki.gemspec
+- static/.markwiki.cfg
+homepage: https://github.com/mahimahi42/markwiki
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby utility for managing wiki-like sites with Markdown.
+test_files: []
+has_rdoc: