docent 0.0.1 → 0.0.2

data/CHANGELOG.markdown

@@ -0,0 +1,15 @@
+# CHANGELOG
+
+## 0.0.2
+
+### Enhancements
+
+- Add generator to simplify installation; use `rails generate docent:install` to mount engine, create initializer file, and copy migrations.
+
+### Bug fixes
+
+- Remove and ignore `Gemfile.lock` from gem to follow best practice.
+
+## 0.0.1
+
+- Initial release.

data/README.markdown

@@ -6,26 +6,23 @@ Docent is a proof-of-concept, based on something I baked into a Rails 2-point-so
 
 ## Setup
 
-1. Add Docent to your Gemfile and install with Bundler.
+1. Add Docent to your Gemfile and install with Bundler:
 
-2. Mount the engine in your application:
+        gem 'docent'
 
-        mount Docent::Engine => "/docent"
+2. Run the Docent generator to mount the app in your routes file, generate an initializer, and copy Docent's migrations to your application:
 
-3. Add the Docent-specific tables to your database:
+        rails generate docent:install
 
-        rake docent:install:migrations
-        rake db:migrate
+3. Run database migrations to add Docent-related data to your database:
 
-4. Create an initializer in `config/initializers/docent.rb`. This establishes a default link (top level of your knowledge base, support form, whatever) for views without support documents in Docent; it also provides a username and password for authentication via HTTP Basic:
+        rake db:migrate
 
-        Docent.default_link = 'http://yourhelpsite.com/docs'
-        Docent.username = 'docent_admin'
-        Docent.password = 'secret'
+4. Edit `config/initializers/docent.rb` to establish a default link (top level of your knowledge base, support form, whatever) for views without support documents in Docent; and to provide a username and password for authentication via HTTP Basic.
 
 ## Usage
 
-1. Load Docent's admin panel at `http://yourapp.com/docent`
+1. Load Docent's admin panel at `http://yourapp.com/docent` and sign in with the credentials you assigned in the initializer.
 
 2. Enter links to support documents. You can enter links specific to a controller#action combination, as well as catch-all links to controllers. Docent looks for links in the following order:
 
@@ -43,7 +40,6 @@ Docent is a proof-of-concept, based on something I baked into a Rails 2-point-so
 
 ## To Do
 
-- add a generator to do most of the setup automatically
 - replace HTTP basic authentication with something integrated with the host application
 - add support for self-hosted documents (I'd link to be able to post documents directly from ScreenSteps into Docent via XMLRPC, for example).
 
@@ -51,7 +47,7 @@ Docent is a proof-of-concept, based on something I baked into a Rails 2-point-so
 
 I'd love to see your ideas and improvements. Fork the project on GitHub, make your changes (with specs!), and submit a pull request. **A note on specs:** I used Capybara feature specs to build Docent; the specs related to end-user access to links currently relies on a non-Rack::Test driver due to the need to check for redirection to an external site. I stuck with Selenium to minimize dependencies, at the expense of speed.
 
-StatBoard is released under the [MIT License][mit]. See MIT-LICENSE for further details.
+Docent is released under the [MIT License][mit]. See MIT-LICENSE for further details.
 
 [mit]: http://www.opensource.org/licenses/MIT
 

data/lib/docent/version.rb

@@ -1,3 +1,3 @@
 module Docent
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/generators/docent/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Create Docent initializer and copy Docent-related migrations
+
+Example:
+    rails generate docent:install

data/lib/generators/docent/install/install_generator.rb

@@ -0,0 +1,26 @@
+module Docent
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def mount_engine_in_routes_file
+      inject_into_file "config/routes.rb", after: "Rails.application.routes.draw do\n" do <<-'ROUTE'
+
+  mount Docent::Engine => "/docent"
+
+      ROUTE
+      end
+    end
+
+    def generate_initializer
+      copy_file "initializer.rb", "config/initializers/docent.rb"
+    end
+
+    def copy_migrations
+      rake "docent:install:migrations"
+    end
+
+    def wrapup
+      puts "All done! Now run rake db:migrate to add Docent's tables to your app and edit config/initializers/docent.rb to finish."
+    end
+  end
+end

data/lib/generators/docent/install/templates/initializer.rb

@@ -0,0 +1,6 @@
+# Replace with the root link to your documentation site
+Docent.default_link = 'http://yourhelpsite.com/docs'
+
+# Replace with HTTP Basic authentication credentials
+Docent.username = 'docent_admin'
+Docent.password = 'secret'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docent
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-26 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,22 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -148,10 +132,14 @@ files:
 - lib/docent/engine.rb
 - lib/docent/version.rb
 - lib/docent.rb
+- lib/generators/docent/install/install_generator.rb
+- lib/generators/docent/install/templates/initializer.rb
+- lib/generators/docent/install/USAGE
 - lib/tasks/docent_tasks.rake
 - MIT-LICENSE
 - Rakefile
 - README.markdown
+- CHANGELOG.markdown
 homepage: https://github.com/ruralocity/docent
 licenses:
 - MIT
@@ -167,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3064965182523156662
+      hash: 1558384049432058431
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -176,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3064965182523156662
+      hash: 1558384049432058431
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23