my_yard 0.0.1

data/my_yard.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = "my_yard"  # i.e. visualruby.  This name will show up in the gem list.
+  s.version = "0.0.1"  # i.e. (major,non-backwards compatable).(backwards compatable).(bugfix)
+  s.add_dependency "visualruby", ">= 3.0.20"
+  s.add_dependency "yard", "= 0.9.0"
+  s.has_rdoc = false
+  s.authors = ["Eric Cunningham"] 
+  s.email = "beagle4321_2000@yahoo.com" # optional
+  s.summary = "Great GUI for generating docs with Yard." # optional
+  s.homepage = "http://visualruby.net/"  # optional
+  s.description = "This program offers a great way to generate docs with yard.  " +
+    "It has a GUI so you don't need to use all the command line parameters.  " +
+    "To see an example of the output, visit http://visualruby.net" 
+  s.executables = ['my_yard']  # i.e. 'vr' (optional, blank if library project)
+  s.default_executable = 'my_yard'  # i.e. 'vr' (optional, blank if library project)
+  s.bindir = ['.']    # optional, default = bin
+#  s.require_paths = ['lib']  # optional, default = lib 
+  s.files = Dir.glob("**/*")
+  s.rubyforge_project = "nowarning" # supress warning message 
+end

data/src/GlobalSettings.rb

@@ -0,0 +1,22 @@
+
+class GlobalSettings
+
+  include GladeGUI
+
+  attr_accessor :browser, :projects, :theme_root, :template_root
+
+  def defaults
+    @browser ||= "firefox"
+    @projects ||= []
+    @theme_root = File.join(Dir.home, "my_yard", "themes")
+    @template_root = File.join(Dir.home, "my_yard", "templates")
+  end
+
+  def add_project(proj_path)
+    unless @projects.include?(proj_path) 
+      @projects << proj_path 
+      VR::save_yaml(self)
+    end 
+  end
+
+end

data/src/MyYard.rb

@@ -0,0 +1,195 @@
+
+class MyYard 
+ 
+  include GladeGUI
+
+  def initialize
+    defaults
+  end
+
+  def defaults
+    @project_root = $open_project
+    @output_dir ||= "doc"
+    @theme = "default" if @theme.nil? or !File.exist?(File.join($env.theme_root, @theme + ".yaml")) 
+    @template ||= "default" 
+    @files ||= "*/**/*.rb */**/*.c"
+    @extra_files ||= "*/**/*.md"
+    @exclude ||= ""
+    @include_public = true if @include_public.nil? # ||= no good on this one  
+    @include_private ||= false
+    @include_protected ||= false
+    @include_private_tag ||= false
+    @title ||= "Generated with Yard 0.8.7.6"
+    @main ||= "README.md"
+    @export_db = true if @export_db.nil?
+    @export_db_path ||= ".yardoc"
+  end
+
+  def before_show()
+    fill_combo_boxes
+  end  
+
+  def buttonGenerate__clicked(*args)
+    save_state
+    args = []
+    @files.split.each { |glob| args << glob }
+    if @extra_files.strip != ""
+      args << "--files"
+      args << @extra_files
+    end
+    args << "--private" if @include_private 
+    args << "--no-public" if !@include_public 
+    args << "--protected" if @include_protected
+    args << "--no-private" if !@include_private_tag  
+    args << "--output-dir"
+    args << @output_dir 
+    args << "--title" 
+    args << @title 
+    if @exclude.strip != ""
+      args << "--exclude"
+      args << @exclude 
+    end
+    if @main.strip != ""
+      args << "--main"
+      args << @main
+    end
+    if @template != "default"
+      args << "--template-path"
+      args << $env.template_root
+      args << "--template"
+      args << @template
+    end
+    if @export_db and @export_db_path.strip != ""
+      args << "--db"
+      args << @export_db_path
+    else
+      args << "--no-save"        
+    end
+    if File.directory?(@project_root) and @project_root != ENV["HOME"]
+      YARD::Registry.clear
+      YARD::Templates::ErbCache.clear!
+      old_dir = Dir.pwd
+      FileUtils.cd(@project_root)
+      YARD::CLI::Yardoc.run(*args)
+      FileUtils.cd(old_dir)
+    else
+      alert "Invalid Project Folder.", parent: self
+    end
+    if @theme != "default"
+      css = VR::load_yaml(YardTheme, File.join($env.theme_root, @theme + ".yaml"))
+      css.export_to(File.join(@project_root, @output_dir, "css", "common.css"))
+#      $default_theme.export_to(File.join(@project_root, @output_dir, "css", "common.css"))
+    else
+      File.delete(File.join(@project_root, @output_dir, "css", "common.css"))
+    end
+  end
+
+  def project_root__changed(*a)
+    return unless @builder[:project_root].model.count == $env.projects.size 
+    return if @builder[:project_root].active_text == $open_project 
+    save_state
+    $open_project = @builder[:project_root].active_text
+    @builder[:window1].destroy  
+  end
+
+  def fill_combo_boxes()
+    @builder[:template].append_text "default"
+    glob = File.join($env.template_root, "*/")
+    Dir.glob(glob).each do |path|
+      @builder[:template].append_text File.basename(path)
+    end
+    fill_themes  
+    $env.projects.each do |path|
+      @builder[:project_root].append_text path 
+    end
+  end
+
+  def fill_themes()
+    @builder[:theme].model.clear
+    glob = File.join($env.theme_root, "*.yaml")
+    Dir.glob(glob).each do |path|
+      @builder[:theme].append_text File.basename(path, ".*")
+    end
+  end
+
+  def buttonEditTheme__clicked(*a)
+    get_glade_variables
+    file = File.join($env.theme_root, @theme + ".yaml")
+    win = VR::load_yaml(YardTheme, file)
+    win.show_glade(self)
+    fill_themes
+    set_glade_variables # select theme again      
+  end
+
+  def buttonOpenProject__clicked(*a)
+    if folder = alert("Enter folder to open:",
+        parent: self, input_text: Dir.home + "/",
+        headline: "Open Folder", button_yes: "Open",
+        button_no: "Cancel")
+      if File.directory?(folder)
+        save_state
+        $open_project = folder
+        @builder[:window1].destroy
+      end  
+    end
+  end
+
+  def buttonBrowse__clicked(*a)
+    save_state
+    begin
+      IO.popen("#{$env.browser} #{File.join(@project_root, @output_dir, @main)}")  
+    rescue
+      if answer = alert("Enter command to start your browser:", parent: self, input_text: $env.browser)
+        $env.browser = answer
+        VR::save_yaml($env)
+      end  
+    end
+  end
+
+  def buttonDeleteProject__clicked(*a)
+    if alert("This will delete this project:\n<b>#{@project_root}</b>\nDo you want to continue?",
+        button_yes: "Delete",
+        button_no: "Cancel",
+        parent: self,
+        headline: "Delete This Project?")
+      $env.projects.delete(@project_root)
+      VR::save_yaml($env)
+      FileUtils.rm_rf File.join(@project_root, ".yardoc", "my_yard.yaml")
+      $open_project = $env.projects.empty? ? :exit : $env.projects[0]
+      @builder[:window1].destroy
+    end
+  end
+
+  def buttonDeleteTheme__clicked(*a)
+    get_glade_variables
+    return if @theme == "default"
+    if alert "Delete theme: <b>#{@theme}</b>?", parent:self, button_no: "Cancel"
+      theme = File.join($env.theme_root, "#{@theme}.yaml")
+      File.delete(theme)
+      @theme = "default"
+      fill_themes
+      set_glade_variables
+    end 
+  end 
+
+  def window1__delete_event(*a)
+    save_state
+    $open_project = :exit
+    return false
+  end
+
+  def buttonCancel__clicked(*a)
+    save_state
+    $open_project = :exit
+    super
+  end
+     
+
+  def save_state
+    get_glade_variables
+    @project_root = $open_project
+    VR::save_yaml(self)
+  end
+
+end
+

data/src/YardTheme.rb

@@ -0,0 +1,77 @@
+class YardTheme
+
+  include GladeGUI
+  include YardThemeDefaults
+
+  attr_accessor :css
+
+  def initialize()
+    defaults
+  end
+
+  def before_show
+    theme = File.basename(@vr_yaml_file, ".*")
+    if theme == "default"
+      alert "The default theme can't be edited.  Make a clone of it, and edit the clone.", 
+            parent: self, width: 300
+    end
+    @builder[:headline].label = "<big>Theme:  #{theme} </big>"
+  end
+
+  def export_to(file)
+    File.open(file, "w") { |f| f.puts to_css }
+  end
+
+  def to_css
+    maps
+    out = import_google_font("h1")
+    out += import_google_font("h2")
+    out += import_google_font("h3")
+    @css.each do |key, val|
+      if val.strip != "" # and val != $default_theme.css[key]
+        val = "'#{val}'" if key.include?("{font-family}") # quotes around font names
+        out = out + key.gsub("}", ": #{val};" ) + "}\n"
+      end
+    end
+    return out
+  end
+
+  def import_google_font(tag)
+    out = ""
+    font = @css["#{tag} {font-family}"] 
+    weight = @css["#{tag} {font-weight}"].strip == "" ? "" : ":" + @css["#{tag} {font-weight}"]
+    out += "@import url('https://fonts.googleapis.com/css?family=#{font.gsub(' ', '+')}#{weight}');\n"
+    return out
+  end
+  
+  def buttonClone__clicked(*a)
+    if clone = alert("This will make a clone of this theme.  " +
+        "Enter the name of the new theme without any extension (only letters and underscores).",
+        headline: "Clone Theme",
+        button_no: "Cancel",
+        input_text: "",
+        width: 350,
+        parent: self)
+# todo lowercase, strip, replace everything except letters, numbers and underscores.
+      path = File.join($env.theme_root, clone + ".yaml")
+      if File.exists?(path)
+        alert "The file, <b>#{clone}</b> already exists.", parent: self
+      else
+        get_glade_variables
+        VR::save_yaml(self, path)
+        @builder[:headline].label = "Theme:  #{clone}"
+      end
+    end 
+  end
+
+  def window1__destroy(*a)
+    save_state if File.exist?(@vr_yaml_file) # maybe deleted
+    super
+  end
+  
+  def save_state
+    get_glade_variables
+    VR::save_yaml(self)
+  end
+       
+end

data/src/YardThemeDefaults.rb

@@ -0,0 +1,100 @@
+## list of css defaults
+#
+
+module YardThemeDefaults
+
+  def defaults
+    @css ||= {}
+
+    # covers table text, paragraph text
+    @css["body {color}"] ||= "#000000"
+
+
+    # #main background (middle doc)
+    @css["#main {background}"] ||= "#ffffff" #ffffff
+ 
+    # background for full list.  the even/odd backgrounds cover top, this is bottom.   
+    @css["body {background-color}"] ||= "#ffffff" #"#ffffff"
+    @css["body {font-size}"] ||= "13px"
+    @css["#main p {width}"] ||= "65%"
+
+    # colors full list links, method summary links
+    @css["#main a, #main a:visited {color}"] ||= "#600" #05a; }
+    # yellow hilight hover for list items, show all, collapse, view source
+    @css["#main a:hover {background}"] ||= "#ffffa5" #ffffa5
+
+    # colors item summary links, collapse, show all, view source
+#    @css[".summary_desc .object_link a, .docstring .object_link a {color}"] ||= "#0055aa" #0055aa
+
+    # full list backgrounds
+    @css[".object_link a {color}"] ||= "#0055aa"
+    @css["li.odd {background}"] ||= "#f0f0f0"  #f0f0f0 
+    @css["li.even {background}"] ||= "#fafafa" #fafafa
+    @css[".item:hover {background}"] ||= "#dddddd" #ddd
+
+    # background color of the selected item in list
+    @css["li.clicked > .item {background}"] ||= "#0055aa" #05a;
+    @css["li.clicked > .item {color}"] ||= "#fafafa" 
+
+
+    # colors text below method summary and changes gray object names in full_list, don't set it.
+    # @css["li {color}"] = "#ca0"
+
+    # gray superclass in list
+    #@css["li.clicked > .item {color}"] = "#00ffff" #ccc; 
+
+
+    # controls background of expand/collapse.  don't use.
+    #@css["h2 small a {background}"] ||= "#fbb" #"#f8f8f8"
+    
+
+
+    # unknown
+#    @css["h2 small a {background}"] ||=  "#ffa" # "#f8f8f8"
+#    @css[".docstring p > code, .docstring p > tt, .tags p > code, .tags p > tt{color}"] = "#7a7" # "#c7254e" 
+#    @css[".docstring p > code, .docstring p > tt, .tags p > code, .tags p > tt{background}"] = "#6f0" # "#f9f2f4" 
+#    @css["a, a:visited {color}"] = "#c7a"  #05a;
+
+#    @css["h2 small a {background}"] ||= "#bbf" #"#f8f8f8"
+
+
+    # headline page
+    @css["h1 {font-family}"] ||= "Assistant"
+    @css["h2 {font-family}"] ||= "Raleway"
+    @css["h3 {font-family}"] ||= "Rubik One" #"Anonymous Pro"
+    @css["h1 {font-weight}"] ||= "200"
+    @css["h2 {font-weight}"] ||= "300"
+    @css["h3 {font-weight}"] ||= ""
+    @css["h1 {font-size}"] ||= "3em"
+    @css["h2 {font-size}"] ||= "1.4em"
+    @css["h3 {font-size}"] ||= "1.4em"
+    @css["h1 {color}"] ||= "#662211"
+    @css["h2 {color}"] ||= "#000000"
+    @css["h3 {color}"] ||= "#000000"
+    @css["h1 {background}"] ||= "#fff"
+    @css["h2 {background}"] ||= "#fff"
+    @css["h3 {background}"] ||= "#fff"
+
+
+
+    # table of contents
+    @css["#toc {background-color}"] ||= "#fee"
+
+    # @css[".summary .summary_signature {background}"] = "#faf"  # summary of instance methods titles
+    @css["p.signature, h3.signature {background}"] = "#0a6"  #tit
+    
+    # List of links:
+    # class = "summary_toggle" is class used for "collapse"
+  end
+
+  def maps
+    # summary of instance methods titles
+    @css[".summary .summary_signature {background}"] = @css["h3 {background}"]
+    # titles over instance method, attr details 
+    @css["p.signature, h3.signature {background}"] = @css["h3 {background}"]
+    #maps the hilighted color of the method, class or file to the same color as object in parentasis in sidebar
+    @css["li.clicked > .item a, li.clicked > .item a:visited {color}"] = @css["li.clicked > .item {color}"] 
+  end
+
+
+end