markdown_explorer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5c0dffd98bb54cee47cca869b1229fe10f9c08b
+  data.tar.gz: 9428148bdb53464b5412a33ebb7a55e61e882692
+SHA512:
+  metadata.gz: 6815db1785674fc75630d6f83c353d2a160242ef691ac5c0f9f31efc0b509e6684bdbc293c49b7afb8085198f28a37083cd2dacad6491a6ad4d0db272decbc88
+  data.tar.gz: 67c15e475a5b59d2ea9a40bc5726254465ec4dcf1ed79dec8c81f4f55da255c351484b3db69480b4a82b71b7b0cb766b01f37910a2240c6f252551c8f94fdf1b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rdavis.bacs@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Richard 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,49 @@
+# MarkdownExplorer
+
+This Ruby Gem uses Sinatra and Redcarpet to allow you to CRUD markdown files on your local system.
+
+Currently, only read functionality is implemented.
+
+
+## Installation
+
+$ gem install markdown_explorer
+
+
+## Usage
+
+Run the executable in a folder with markdown files.
+
+```bash
+$ mdexplore
+```
+
+Then, navigate to <http://localhost:8080> in your browser
+
+![MarkdownExplorer](image.png)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. `rackup` will allow you to run a development instance of the app. `rake -T` for other commands.
+
+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).
+
+
+## TODO
+
+* Create markdown files in browser
+* Edit/update markdown files in the browser
+* Delete markdown files from the browser
+* Create a better navigation system (tree view)
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LaunchAcademy/markdown_explorer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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 "markdown_explorer"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.ru

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler"
+
+Bundler.require
+
+require_relative "./lib/markdown_explorer/application"
+run MarkdownExplorer::Application

data/exe/mdexplore

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "rack"
+require_relative "../lib/markdown_explorer"
+
+Rack::Handler::WEBrick.run MarkdownExplorer::Application

data/lib/markdown_explorer/application.rb

@@ -0,0 +1,14 @@
+require "sinatra"
+
+class MarkdownExplorer::Application < Sinatra::Base
+  get "/" do
+    @files = MarkdownExplorer::Files.new(Dir.pwd)
+    erb :index
+  end
+
+  get "/show" do
+    markdown = File.read(params[:filename])
+    @markup = MarkdownExplorer::Renderer.new(markdown).markup
+    erb :show
+  end
+end

data/lib/markdown_explorer/files.rb

@@ -0,0 +1,30 @@
+require "tmpdir"
+
+class MarkdownExplorer::Files
+  EXTENSIONS = %w(md mdown markdown)
+
+  attr_reader :path
+
+  def initialize(path)
+    @path = path
+    find_files
+  end
+
+  def to_a
+    @collection
+  end
+
+  private
+
+  def find_files
+    @collection = Dir[search_string]
+  end
+
+  def search_string
+    File.join(path, "**", "*.{#{extensions}}")
+  end
+
+  def extensions
+    EXTENSIONS.join(",")
+  end
+end

data/lib/markdown_explorer/public/css/application.css

@@ -0,0 +1,16 @@
+table {
+  width: 100%;
+}
+
+.tabs-content {
+  margin-bottom: 0;
+}
+
+.tabs-content > .content {
+  padding-top: 0;
+  padding-bottom: 0;
+}
+
+.tab-title a {
+  padding: 0.5rem 1rem !important;
+}