mount_doc 0.0.2 → 0.0.3

data/README.md

@@ -4,7 +4,7 @@ Railsアプリケーション組み込み型ドキュメント生成ツール
 
 ## Configure
 
-`MountDoc::Config`に書き込み
+config/initialzier/mount_doc.rb に書き込み
 
 - `auto_mount`: 自動でマウントするか否か(default: false)
 - `auto_mount_path`: 自動でマウントする先のパス(default: /doc)
@@ -28,12 +28,17 @@ Or install it yourself as:
 
     $ gem install mount_doc
 
+And then generate initializer file
+
+    rails generator mount_doc:install
+
 And added config/routes.rb
 
     mount MountDoc::Engine => '/prefix'
 
 access to http://localhost:3000/prefix !
 
+
 ## Usage
 
 1. Installation

data/lib/generators/mount_doc/install_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/base'
+
+module MountDoc
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "create initializer file for mount_doc."
+      def copy_initializer
+        template "initializer.rb", "config/initializers/mount_doc.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,46 @@
+MountDoc.config do |conf|
+  #############
+  # auto_mount
+  #############
+  # set true if you want to mount automaticaly (default false)
+  #
+  # conf.auto_mount = true
+  #
+
+  ##################
+  # auto_mount_path
+  ##################
+  # path to mount document (default: /doc)
+  #
+  # conf.auto_mont_path = '/documents'
+  #
+
+  #####################
+  # visible_components
+  #####################
+  # document component types you want to include into menu
+  # types:  [:files, :urls, :controllers, :models]
+  # default: [:files, :urls, :controllers]
+  #
+  # conf.visible_components = [:files, :controllers]
+  #
+
+  ################
+  # doc_file_path
+  ################
+  # path to static documents (default: doc)
+  #
+  # conf.doc_file_path = 'app/view/statics'
+
+  #########
+  # markup
+  #########
+  # format of comments (default: rdoc)
+  #
+  # ** you must include gem into Gemfile, like
+  #     gem 'github-markdown'
+  #
+  # config.markup = 'markdown'
+  #
+
+end

data/lib/mount_doc.rb

@@ -4,6 +4,10 @@ module MountDoc
   autoload :VERSION, "mount_doc/version"
   autoload :Config, "mount_doc/config"
   autoload :Document, "mount_doc/document"
+
+  def self.config(&block)
+    yield(MountDoc::Config)
+  end
 end
 
 require 'mount_doc/string_patch'

data/lib/mount_doc/version.rb

@@ -1,3 +1,3 @@
 module MountDoc
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/mount_doc/config_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 describe MountDoc::Config do
   describe :auto_mount do
     subject{ MountDoc::Config.auto_mount? }
-    it("default: false"){ should be_false }
+    it("default: false") { should be_false }
 
-    it("writable boolean"){
+    it("writable boolean") {
       MountDoc::Config.auto_mount = 1
       should be_true
     }
@@ -57,17 +57,27 @@ describe MountDoc::Config do
 
   describe :doc_file_path do
     subject{ MountDoc::Config.doc_file_path }
-    
+
     it("default: 'doc'"){ should == 'doc' }
   end
 
   describe :defaults! do
     subject{ MountDoc::Config }
 
-    it("set default"){ 
+    it("set default"){
       subject.visible_protected_methods = true
       subject.defaults!
       subject.visible_protected_methods.should be_false
     }
   end
+
+  describe :cool_config do
+    it "change config" do
+      lambda{
+        MountDoc.config do |conf|
+          conf.visible_components = [:files]
+        end
+      }.should change(MountDoc::Config, :visible_components).to([:files])
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mount_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-19 00:00:00.000000000 Z
+date: 2012-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -114,6 +114,8 @@ files:
 - app/views/mount_doc/mount_doc/index.slim
 - app/views/mount_doc/mount_doc/not_found.slim
 - config/routes.rb
+- lib/generators/mount_doc/install_generator.rb
+- lib/generators/templates/initializer.rb
 - lib/mount_doc.rb
 - lib/mount_doc/config.rb
 - lib/mount_doc/document.rb
@@ -185,7 +187,6 @@ files:
 - spec/mock/rails_3.2.3/db/schema.rb
 - spec/mock/rails_3.2.3/db/seeds.rb
 - spec/mock/rails_3.2.3/doc/README_FOR_APP
-- spec/mock/rails_3.2.3/doc/うんこしたい.rdoc
 - spec/mock/rails_3.2.3/lib/assets/.gitkeep
 - spec/mock/rails_3.2.3/lib/tasks/.gitkeep
 - spec/mock/rails_3.2.3/log/.gitkeep
@@ -222,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Railsで書かれたアクションにコメントを書くと、動的にドキュメントを生成し、その結果をRailsアプリにマウントする
@@ -287,7 +288,6 @@ test_files:
 - spec/mock/rails_3.2.3/db/schema.rb
 - spec/mock/rails_3.2.3/db/seeds.rb
 - spec/mock/rails_3.2.3/doc/README_FOR_APP
-- spec/mock/rails_3.2.3/doc/うんこしたい.rdoc
 - spec/mock/rails_3.2.3/lib/assets/.gitkeep
 - spec/mock/rails_3.2.3/lib/tasks/.gitkeep
 - spec/mock/rails_3.2.3/log/.gitkeep

data/spec/mock/rails_3.2.3/doc//343/201/206/343/202/223/343/201/223/343/201/227/343/201/237/343/201/204.rdoc

@@ -1,3 +0,0 @@
-= だるい
-
-ほげ〜〜〜〜