markdaver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b080917017146a73b359112db742833de3ccd8b4
+  data.tar.gz: e00b32f7a3843470a2159accccf019b7d10624c9
+SHA512:
+  metadata.gz: 54188bab2ee4a51c628b8827d73a5a7da47b4f511932162bcce0b3b697a5f4250724309cea681edd8edb36004b46171476a8222122cb588799cf071a5932fc95
+  data.tar.gz: b10c2109d3bacd7b2900282ef2e5fd686b28c81d476ebecd0eee358efc65e4fd3cecc9f141948257ea98ad5b3b595cb7a2a4dcfbec80b0cfb99752ce9d18057a

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in markdaver.gemspec
+gemspec
+gem "byebug"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ricardo Valeriano
+
+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,38 @@
+# Markdaver - A web based markdown editor
+
+This is a (ruby) rack application that uses a GREAT web interface (thanks
+https://github.com/jbt/markdown-editor) to edit new or existent markdown files
+with a nice preview side by side within the editor.
+
+## Installation and Usage
+
+You can install it as a gem, in the classic way:
+
+    $ gem install markdaver
+
+This will create an executable called `markdaver`, that can be invoked to
+edit a file in any path (existent or new) given by the `MARKDOWN` env var.
+
+    MARKDOWN="~/my/new/book/intro.md" markdaver
+
+If you will prefer to clone the project, after clone, just go the main dir an
+execute the `bundle exec rackup`, you can also use the environment variable
+like so:
+
+    MARKDOWN="~/my/new/book/intro.md" bundle exec rackup
+
+## 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.
+
+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/ricardovaleriano/markdaver.
+
+
+## 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 "markdaver"
+
+# 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,34 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "ostruct"
+require 'markdaver'
+require "markdaver/inject_index_script"
+require "markdaver/markdown_editor_env"
+
+FILE = ENV['MARKDOWN'] || ENV['FILE_TO_OPEN'] || './omg.md'
+
+app = Rack::Builder.new do
+  environment = Markdaver::MarkdownEditorEnv.new(
+    root_path: File.expand_path("../markdown-editor/"),
+    script_file: File.expand_path("./web/script.js"),
+    file_to_open: FILE
+  )
+
+  map '/save' do
+    run ->(env) {
+      request = Rack::Request.new(env)
+      # TODO:
+      #   - add some specs!!!
+      #   - store the edition history (create a file for each update?)
+      #   - save after some seconds of inactivity
+      #   - ...
+      File.write FILE, request.params['markdown']
+      [200, {'Content-Type' => 'text/plain'}, ['post received!']]
+    }
+  end
+
+  use Markdaver::InjectIndexScript, markdown_editor_env: environment
+  use Rack::Static, urls: [''], root: environment.root_path, index: 'index.html'
+  run ->(env) { [200, {'Content-Type' => 'text/plain'}, ['hi there']] }
+end
+
+run app

data/exe/markdaver

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+`rackup #{File.expand_path('../../config.ru', __FILE__)}`

data/lib/markdaver.rb

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

data/lib/markdaver/inject_index_script.rb

@@ -0,0 +1,18 @@
+module Markdaver
+  class InjectIndexScript
+    def initialize(app, options = {})
+      @app = app
+      @environment = options[:markdown_editor_env]
+    end
+
+    def call(env)
+      if env["PATH_INFO"] == "/"
+        status, header, _ = @app.call env
+        header["Content-Length"] = @environment.index.length.to_s
+        [status, header, [@environment.index]]
+      else
+        @app.call env
+      end
+    end
+  end
+end

data/lib/markdaver/markdown_editor_env.rb

@@ -0,0 +1,35 @@
+module Markdaver
+  class MarkdownEditorEnv
+    attr_reader :root_path
+
+    def initialize(
+      root_path: File.expand_path("../../../markdown-editor/"),
+      script_file: nil,
+      file_to_open: nil
+    )
+      @root_path = root_path
+      @script_file = script_file
+      @file_to_open = file_to_open
+    end
+
+    def index
+      @index ||= File.read(File.join @root_path, "index.html")
+        .gsub(/<\/body>/, "\n<script>#{script}</script>\\0")
+    end
+
+    private
+
+    def script
+      javascript_code = ''
+      if @file_to_open and File.exist?(@file_to_open)
+        javascript_code << %{ var openFile = `#{File.read(@file_to_open)}`; }
+      end
+      javascript_code + script_load
+    end
+
+    def script_load
+      (@script_file && File.read(@script_file)) ||
+        %{console.log("we need some script in the environment");}
+    end
+  end
+end

data/lib/markdaver/version.rb

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

data/markdaver.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markdaver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "markdaver"
+  spec.version       = Markdaver::VERSION
+  spec.authors       = ["Ricardo Valeriano"]
+  spec.email         = ["ricardo.valeriano@gmail.com"]
+
+  spec.summary       = %q{Add local file autosave features to github.com/jbt/markdown-editor.}
+  spec.description   = %q{Runs a local server so you can edit and local (auto) save markdown documents.}
+  spec.homepage      = "https://github.com/ricardovaleriano/markdaver."
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "rack"
+end

data/web/script.js

@@ -0,0 +1,39 @@
+function _save() {
+  var request = new XMLHttpRequest();
+  request.addEventListener("load", function(){
+    console.log("request done");
+  });
+  request.open("POST", "/save");
+  request.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
+
+  var markdown = editor.getValue();
+  request.send("markdown=" + encodeURIComponent(markdown));
+}
+
+function timeToSave(ev) {
+  keyStrokes++;
+
+  if(keyStrokes == keyStrokesMax) {
+    keyStrokes = 0;
+    console.log(keyStrokesMax + " key strokes! saving...");
+    _save();
+  }
+}
+
+var _originalSaveAsMarkdown = saveAsMarkdown();
+
+function saveAsMarkdown() {
+  _save();
+}
+
+var dataModifiedEventCount = 0;
+var dataModifiedEventMax = 3;
+var keyStrokes = 0;
+var keyStrokesMax = 20;
+
+var codeTextarea = document.getElementsByTagName("textarea")[1];
+codeTextarea.addEventListener("keyup", timeToSave, false);
+
+if(openFile != undefined) {
+  editor.setValue(openFile);
+}

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: markdaver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ricardo Valeriano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '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: rack
+  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: Runs a local server so you can edit and local (auto) save markdown documents.
+email:
+- ricardo.valeriano@gmail.com
+executables:
+- markdaver
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.ru
+- exe/markdaver
+- lib/markdaver.rb
+- lib/markdaver/inject_index_script.rb
+- lib/markdaver/markdown_editor_env.rb
+- lib/markdaver/version.rb
+- markdaver.gemspec
+- web/script.js
+homepage: https://github.com/ricardovaleriano/markdaver.
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Add local file autosave features to github.com/jbt/markdown-editor.
+test_files: []
+has_rdoc: