doccoli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42a6d559e1048b9abcaa7eaa21244a834b10c1f1
+  data.tar.gz: 7720f5f300dc64bbbbe2897bec4a32d71132d19a
+SHA512:
+  metadata.gz: 9a2c14ba3c508601f60aaec6cd57f607c544c9a4cf68b15d3edfb1152696ba413b2dc58ebe7a0726020865d0678208e1d2047cca372f691676eefe4a38f03888
+  data.tar.gz: a461ded6e615300aac1de30e0f558e500e1ca330cc05d67e4efc90ecb610fc6c70cac4bb7a9381a5cac6e2043d443698fc6b52ef0142a7edb122a1b6d867c873

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Marvin Danig
+
+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,39 @@
+# Doccoli
+Doccoli is a modern lightweight `rails engine` that provides for management of *hierarchical* documentation. 
+
+Once installed, you'll have a ready-to-use markdown based interface to view as well as edit product documentation on the go. It's nice!
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doccoli'
+```
+
+And then run:
+```bash
+$ bundle
+```
+
+Next, you'll need to run the setup generator which will add a route to your `config/routes.rb` file for the Documentation interface.
+
+```
+bundle exec rails generate doccoli:setup
+```
+
+To populate your database schema and load the initial documentation pages.
+
+```
+bundle exec rake db:migrate doccoli:install_guides
+```
+
+All set!
+
+Now you can (re)start your Rails application and browse to `/docs` path to view your shiny new documentation system.
+
+
+## Contributing
+Contribution directions go here.
+
+## 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,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Doccoli'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/doccoli_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/doccoli .js
+//= link_directory ../stylesheets/doccoli .css

data/app/assets/javascripts/doccoli/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/doccoli/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/doccoli/application_controller.rb

@@ -0,0 +1,5 @@
+module Doccoli
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/doccoli/application_helper.rb

@@ -0,0 +1,4 @@
+module Doccoli
+  module ApplicationHelper
+  end
+end

data/app/jobs/doccoli/application_job.rb

@@ -0,0 +1,4 @@
+module Doccoli
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/doccoli/application_mailer.rb

@@ -0,0 +1,6 @@
+module Doccoli
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/doccoli/application_record.rb

@@ -0,0 +1,5 @@
+module Doccoli
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/doccoli/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Doccoli</title>
+  <%= stylesheet_link_tag    "doccoli/application", media: "all" %>
+  <%= javascript_include_tag "doccoli/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Doccoli::Engine.routes.draw do
+end

data/lib/doccoli.rb

@@ -0,0 +1,5 @@
+require "doccoli/engine"
+
+module Doccoli
+  # Your code goes here...
+end

data/lib/doccoli/engine.rb

@@ -0,0 +1,5 @@
+module Doccoli
+  class Engine < ::Rails::Engine
+    isolate_namespace Doccoli
+  end
+end

data/lib/doccoli/version.rb

@@ -0,0 +1,3 @@
+module Doccoli
+  VERSION = '0.1.0'
+end

data/lib/tasks/doccoli_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :doccoli do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: doccoli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marvin Danig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Doccoli is a modern lightweight rails engine that provides for management
+  of hierarchical documentation.
+email:
+- marvin@marvindanig.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/doccoli_manifest.js
+- app/assets/javascripts/doccoli/application.js
+- app/assets/stylesheets/doccoli/application.css
+- app/controllers/doccoli/application_controller.rb
+- app/helpers/doccoli/application_helper.rb
+- app/jobs/doccoli/application_job.rb
+- app/mailers/doccoli/application_mailer.rb
+- app/models/doccoli/application_record.rb
+- app/views/layouts/doccoli/application.html.erb
+- config/routes.rb
+- lib/doccoli.rb
+- lib/doccoli/engine.rb
+- lib/doccoli/version.rb
+- lib/tasks/doccoli_tasks.rake
+homepage: https://marvindanig.com
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Handcrafted documentation for your rails 5.1+ applications.
+test_files: []