doc_to_dash 0.0.4 → 0.0.5

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.idea/
+.idea/
+.DS_Store

data/README.md

@@ -1,6 +1,6 @@
 # DocToDash
 
-DocToDash converts documentation files (at the moment only YARD) into a classes and methods docset that can then be loaded into the docset viewing program: Dash.
+DocToDash converts documentation files (Rdoc Darkfish / YARD) into a classes and methods docset that can then be loaded into the docset viewing program: Dash.
 
 ## Installation
 
@@ -42,9 +42,9 @@ Or install it yourself as:
 
     <tr>
         <td>:icon_path</td>
-        <td>nil/</td>
+        <td>../default_icon.png</td>
         <td>The icon file that will be put in the docset.  Shown in Dash.</td>
-        <td>No</td>
+        <td>No (can be nil, will not transfer default_icon.png)</td>
     </tr>
 
     <tr>
@@ -71,14 +71,14 @@ Or install it yourself as:
     <tr>
         <td>:parser</td>
         <td>DocToDash::YardParser</td>
-        <td>Parser to use to pull out classes and modules.  YARD is only supported at the moment.</td>
+        <td>Parser to use to pull out classes and modules.  DocToDash::YardParser / DocToDash::RdocDarkfishParser.</td>
         <td>Yes</td>
     </tr>
 </table>
 
 ## Usage
 
-Generate YARD documentation (or as time progresses and we support rdoc, generate that). This will output your Rails application's YARD documentation to doc/yard:
+Generate YARD documentation (or darkfish rdoc). This below will output your Rails application's YARD documentation to doc/yard:
 
     $ yardoc app/**/*.rb lib/**/*.rb --protected --private --embed-mixins --output-dir doc/yard/
 
@@ -103,3 +103,7 @@ This will create a docset in the docset_output_path then you just need to load t
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Thanks
+
+Default Icon: Crash Test Dummy designed by Luis Prado from The Noun Project

data/lib/doc_to_dash.rb

@@ -14,7 +14,7 @@ module DocToDash
           :docset_name            => 'DefaultDocset',
           :docset_output_path     => 'doc/',      # This is where the actual package will be created.
           :docset_output_filename => lambda {@options[:docset_name] + '.docset' },
-          :icon_path              => nil,                                                         # This is the docset icon that never changes, if you want a default icon just set this to nil.
+          :icon_path              => File.expand_path(File.expand_path(File.dirname(__FILE__)) + '/../default_icon.png'), # This is the docset icon that never changes, if you want a default icon just set this to nil.
           :doc_input_path         => nil,                                                         # This is the actual docs to copy over to the Docset.
           :doc_save_folder        => 'docs',                                                      # This is the directory name it will store under /Contents/Resources/Documents/{this}
           :verbose                => true,
@@ -94,7 +94,11 @@ module DocToDash
     def copy_default_files
       log "Copy default Docset files over."
 
-      FileUtils.cp @options[:icon_path], @docset_path + '/' unless @options[:icon_path].nil?
+      unless @options[:icon_path].nil?
+        FileUtils.cp @options[:icon_path], @docset_path + '/'
+        FileUtils.mv @docset_path + '/' + File.basename(@options[:icon_path]), @docset_path + '/icon.png'
+      end
+
       File.open(@docset_path + '/Contents/Info.plist', 'w+') { |file| file.write(default_plist.gsub('{DOCSET_NAME}', @options[:docset_name])) }
     end
 

data/lib/doc_to_dash/version.rb

@@ -1,3 +1,3 @@
 module DocToDash
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/doc_to_dash/yard_parser.rb

@@ -2,12 +2,13 @@ module DocToDash
   class YardParser
     def initialize(doc_directory)
       @doc_directory = doc_directory
+
+      fix_css_file
     end
 
-    #TODO: fix the CSS file and remove the top header.  JS will not work on Dash.
-    #def fix_css_file
-    #  File.open(@doc_directory + '/rdoc.css', 'a') { |file| file.write('nav, footer { display: none !important; } #documentation { margin: 0 !important; } .method-source-code { display: block !important; }') }
-    #end
+    def fix_css_file
+      File.open(@doc_directory + '/css/style.css', 'a') { |file| file.write('#header, .showSource, .inheritanceTree, .inheritName, h2 small { display: none; } .source_code, .fullTree { display: block !important; }') }
+    end
 
     def parse_classes
       classes_file = File.read(@doc_directory + '/class_list.html')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_to_dash
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -57,6 +57,7 @@ files:
 - README.md
 - Rakefile
 - bin/doc_to_dash
+- default_icon.png
 - doc_to_dash.gemspec
 - lib/doc_to_dash.rb
 - lib/doc_to_dash/rdoc_darkfish_parser.rb