doing 1.0.19 → 1.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d675f8d0e03a45a55e9be965c7e1dd5da2e1f6329bd313327c92234ec54f4b57
-  data.tar.gz: 591e84462f5a8a7d38b94f3daf6482c65d262306f246ffcb9d5125a794eb25bd
+  metadata.gz: b9c612dd40f383ef86320a0484b1ed9408fa761f13346f1ba64133ce94966fca
+  data.tar.gz: 5d5ef023946246e76a94bb726f3db8f623137a0930771d11c3dc180465c219a6
 SHA512:
-  metadata.gz: cd522f9ba33483143c8f792d1c4e20c4952a91b968859f8b8c1350fe4b80c063f4158f4301c670164a4fa8404f4c9a94b522f025716a1a0effcab85485e83b91
-  data.tar.gz: 79170973a2dd8b49d31ef3f6b576ab9bc9c34f135585b8f0aac074cb527f5a3da08310d1f6d7192ced81c3747f2289b9ce1065de6bbc2b31627093f209473e5a
+  metadata.gz: baae64a38314c2a406852a8479c3525fd287100aa738e538051e2f94848a1352d1f8ebbc8e3ed6b3136a9a3c5d49a6b28a6c1f53898a3bd0a26430505b907eda
+  data.tar.gz: 1b1c6af8c049e7c3f7e3eb9407e89af9f19e714b4ae3b740fe95b252515be5def9ed539e5df5a61d965440a2c4b7d2570bbf83ef126e7403e454714e97072dfc

data/README.md

@@ -91,7 +91,7 @@ A basic configuration looks like this:
     :include_notes: true
 
 
-The config file is stored in `~/.doingrc`, and is created on the first run.
+  The config file is stored in `~/.doingrc`, and a skeleton file is created on the first run. Just run `doing` on its own to create the file.
 
 ### Per-folder configuration
 
@@ -312,6 +312,14 @@ And a few special colors you'll just have to try out to see:
 
 Any time you use one of the foreground colors it will reset the bold and background settings to their default automatically. You can force a reset to default terminal colors using `%default`.
 
+### HTML Templates
+
+For commands that provide an HTML output option, you can customize the templates used for markup and CSS. The markup uses [HAML](http://haml.info/), and the styles are pure CSS.
+
+To export the default configurations for customization, use `doing templates --type=[HAML|CSS]`. This will output to STDOUT where you can pipe it to a file, e.g. `doing templates --type=HAML > my_template.haml`. You can modify the markup, the CSS, or both.
+
+Once you have either or both of the template files, edit `.doingrc` and look for the `html_template:` section. There are two subvalues, `haml:` and `css:`. Add the path to the templates you want to use. A tilde may be substituted for your home directory, e.g. `css: ~/styles/doing.css`.
+
 ## Usage
 
     doing [global options] command [command options] [arguments...]
@@ -540,12 +548,19 @@ Feel free to [poke around](http://github.com/ttscoff/doing/), I'll try to add mo
 
 ## Changelog
 
+#### 1.0.20
+
+- Rewrite HTML export templates with responsive layout and typography
+- Ability to customize the HTML output using HAML and CSS
+- New command `doing templates` to export default templates for HAML and CSS
+- New config options under `html_template` for `haml` and `css`
+
 #### 1.0.19
 
 - For `doing note -e` include the entry title so you know what you're adding a note to
 - For any other command that allows `-e` include a comment noting that anything after the first line creates a note
 - Ignore # comments when parsing editor results
-
+- Add a .md extension to the temp file passed to the editor so you can take advantage of any syntax highlighting and other features in your editor
 
 #### 1.0.18
 
@@ -692,8 +707,6 @@ Catching up on the changelog. Kind of. A lot has happened, mostly fixes.
 - fuzzy section guessing when specified section isn't found
 - fuzzy view guessing for `doing view` command
 
-----
-
 #### 0.1.9
 
 - colors in templated output

data/bin/doing

@@ -226,6 +226,28 @@ command :meanwhile do |c|
   end
 end
 
+desc 'Output HTML templates for customization. Save them to files and use them in the configuration file under html_template'
+command :templates do |c|
+  c.desc "Type of template to output (HAML|CSS)"
+  c.arg_name 'template_type'
+  c.flag [:t,:type]
+
+  c.action do |global_options,options,args|
+    unless options[:type]
+      raise "No type specified, use --type=[HAML|CSS]"
+    else
+      if options[:t] =~ /html|haml/i
+        $stdout.puts wwid.haml_template
+      elsif options[:t] =~ /css/i
+        $stdout.puts wwid.css_template
+      else
+        raise "Invalid type specified, use --type=[HAML|CSS]"
+      end
+    end
+  end
+end
+
+
 desc 'Add an item to the Later section'
 arg_name 'entry'
 command :later do |c|

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '1.0.19'
+  VERSION = '1.0.20'
 end

data/lib/doing/wwid.rb

@@ -54,6 +54,11 @@ class WWID
     @config['doing_file'] ||= "~/what_was_i_doing.md"
     @config['current_section'] ||= 'Currently'
     @config['editor_app'] ||= nil
+
+    @config['html_template'] ||= {}
+    @config['html_template']['haml'] ||= nil
+    @config['html_template']['css'] ||= nil
+
     @config['templates'] ||= {}
     @config['templates']['default'] ||= {
       'date_format' => '%Y-%m-%d %H:%M',
@@ -173,6 +178,14 @@ class WWID
     }
   end
 
+  def haml_template
+    IO.read(File.join(File.dirname(__FILE__), '../templates/doing.haml'))
+  end
+
+  def css_template
+    IO.read(File.join(File.dirname(__FILE__), '../templates/doing.css'))
+  end
+
   def create(filename=nil)
     if filename.nil?
       filename = @doing_file
@@ -960,31 +973,18 @@ EOTEMPLATE
         }
       }
 
-      style = "body{background:#fff;color:#333;font-family:Helvetica,arial,freesans,clean,sans-serif;font-size:16px;line-height:120%;text-align:justify;padding:20px}h1{text-align:left;position:relative;left:220px;margin-bottom:1em}ul{list-style-position:outside;position:relative;left:170px;margin-right:170px;text-align:left}ul li{list-style-type:none;border-left:solid 1px #ccc;padding-left:10px;line-height:2;position:relative}ul li .date{font-size:14px;position:absolute;left:-122px;color:#7d9ca2;text-align:right;width:110px;line-height:2}ul li .tag{color:#999}ul li .note{display:block;color:#666;padding:0 0 0 22px;line-height:1.4;font-size:15px}ul li .note:before{content:'\\25BA';font-weight:300;position:absolute;left:40px;font-size:8px;color:#aaa;line-height:3}ul li:hover .note{display:block}span.time{color:#729953;float:left;position:relative;padding:0 5px;font-size:15px;border-bottom:dashed 1px #ccc;text-align:right;background:#f9fced;margin-right:4px}table td{border-bottom:solid 1px #ddd;height:24px}caption{text-align:left;border-bottom:solid 1px #aaa;margin:10px 0}table{width:400px;margin:50px 0 0 211px}th{padding-bottom:10px}th,td{padding-right:20px}table{max-width:400px;margin:50px 0 0 221px}ul li .section{color:#dbbfad;border-left:solid 1px #dbbfad;border-right:solid 1px #dbbfad;border-radius:25px;padding:0 4px;line-height:1 !important;font-size:.8em}ul li .section:hover{color:#c5753f}ul li a:link{color:#64a9a5;text-decoration:none;background-color:rgba(203,255,251,.15)}"
-      template =<<EOT
-!!!
-%html
-%head
-  %meta{"charset" => "utf-8"}/
-  %meta{"content" => "IE=edge,chrome=1", "http-equiv" => "X-UA-Compatible"}/
-  %title what are you doing?
-  %style= @style
-%body
-  %header
-    %h1= @page_title
-  %article
-    %ul
-      - @items.each do |i|
-        %li
-          %span.date= i[:date]
-          = i[:title]
-          %span.section= i[:section]
-          - if i[:time] && i[:time] != "00:00:00"
-            %span.time= i[:time]
-          - if i[:note]
-            %span.note= i[:note].map{|n| n.strip }.join('<br>')
-    = @totals
-EOT
+      if @config['html_template']['haml'] && File.exists?(File.expand_path(@config['html_template']['haml']))
+        template = IO.read(File.expand_path(@config['html_template']['haml']))
+      else
+        template = haml_template
+      end
+
+      if @config['html_template']['css'] && File.exists?(File.expand_path(@config['html_template']['css']))
+        style = IO.read(File.expand_path(@config['html_template']['css']))
+      else
+        style = css_template
+      end
+
       totals = opt[:totals] ? tag_times("html") : ""
       engine = Haml::Engine.new(template)
       puts engine.render(Object.new, { :@items => items_out, :@page_title => page_title, :@style => style, :@totals => totals })

data/lib/doing.rb

@@ -9,4 +9,3 @@ require 'chronic'
 require 'haml'
 require 'json'
 require 'doing/wwid.rb'
-

data/lib/templates/doing.css

@@ -0,0 +1,169 @@
+body {
+  background: #fff;
+  color: #333;
+  font-family: Helvetica,arial,freesans,clean,sans-serif;
+  font-size: 21px;
+  line-height: 1.5;
+  text-align: justify;
+}
+
+@media only screen and (max-width: 900px) {
+  body {
+    font-size: calc(12px + 1vw);
+  }
+
+  .date,
+  .note {
+    font-size: calc(8px + 1vw)!important;
+  }
+}
+
+h1 {
+  margin-bottom: 1em;
+  margin-left: .1em;
+  position: relative;
+  text-align: left;
+}
+
+ul {
+  list-style-position: outside;
+  position: relative;
+  text-align: left;
+  padding-left: 0;
+}
+
+article > ul > li {
+  display: grid;
+  grid-template-columns: 14ch auto;
+  line-height: 1.2;
+  list-style-type: none;
+  padding-left: 10px;
+  position: relative;
+  word-break: break-word;
+  transition: background .2s ease-in-out;
+}
+
+article > ul > li:hover {
+  background: rgba(150,150,150,.05);
+}
+
+.date {
+  color: #7d9ca2;
+  font-size: 14px;
+  padding: 15px 1ch 0 0;
+  text-align: right;
+  white-space: nowrap;
+  transition: color .2s ease-in-out;
+}
+
+.entry {
+  border-left: solid 1px #ccc;
+  line-height: 1.2;
+  padding: 10px 10px 10px 3ch;
+  text-indent: -2ch;
+}
+
+.tag {
+  color: #999;
+  transition: color 1s ease-in;
+}
+
+.note {
+  color: #aaa;
+  display: block;
+  font-size: 16px;
+  line-height: 1.1;
+  padding: 1em 0 0 2ch;
+  position: relative;
+  transition: color .2s ease-in-out;
+}
+
+li:hover .note {
+  color: #777;
+}
+
+li:hover .tag {
+  color: rgb(182, 120, 125);
+}
+
+li:hover .date {
+  color: rgb(100, 169, 165);
+}
+
+.note li {
+    margin-bottom: .5em;
+    list-style: none;
+    position: relative;
+}
+
+.note li:before {
+  color: #ddd;
+  content: '\25BA';
+  font-size: 12px;
+  font-weight: 300;
+  left: -3ch;
+  position: absolute;
+  top: .25em;
+}
+
+.time {
+  background: #f9fced;
+  border-bottom: dashed 1px #ccc;
+  color: #729953;
+  font-size: 15px;
+  margin-right: 4px;
+  padding: 0 5px;
+  position: relative;
+  text-align: right;
+}
+
+table td {
+  border-bottom: solid 1px #ddd;
+  height: 24px;
+}
+
+caption {
+  border-bottom: solid 1px #aaa;
+  margin: 10px 0;
+  text-align: left;
+}
+
+table {
+  margin: 50px 0 0 211px;
+  width: 400px;
+}
+
+th {
+  padding-bottom: 10px;
+}
+
+th, td {
+  padding-right: 20px;
+}
+
+table {
+  margin: 50px 0 2em 16ch;
+  max-width: 400px;
+}
+
+.section {
+  border-left: solid 1px rgb(182, 120, 125);
+  border-radius: 25px;
+  border-right: solid 1px rgb(182, 120, 125);
+  color: rgb(182, 120, 125);
+  font-size: .8em;
+  line-height: 1 !important;
+  padding: 0 4px;
+  transition: background .4s ease-in, color .4s ease-in;
+}
+
+li:hover .section {
+  color: #fff;
+  background: rgb(182, 120, 125);
+}
+
+a:link {
+  background-color: rgba(203, 255, 251, .15);
+  color: #64a9a5;
+  text-decoration: none;
+}

data/lib/templates/doing.haml

@@ -0,0 +1,25 @@
+!!!
+%html
+%head
+  %meta{"charset" => "utf-8"}/
+  %meta{"content" => "IE=edge,chrome=1", "http-equiv" => "X-UA-Compatible"}/
+  %title what are you doing?
+  %style= @style
+%body
+  %header
+    %h1= @page_title
+  %article
+    %ul
+      - @items.each do |i|
+        %li
+          %span.date= i[:date]
+          %div.entry
+            = i[:title]
+            %span.section= i[:section]
+            - if i[:time] && i[:time] != "00:00:00"
+              %span.time= i[:time]
+            - if i[:note]
+              %ul.note
+                - i[:note].map{|n| n.strip }.each do |li|
+                  %li= li
+    = @totals

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 1.0.19
+  version: 1.0.20
 platform: ruby
 authors:
 - Brett Terpstra
@@ -96,16 +96,22 @@ dependencies:
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.3
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.3
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +187,8 @@ files:
 - lib/doing.rb
 - lib/doing/version.rb
 - lib/doing/wwid.rb
+- lib/templates/doing.css
+- lib/templates/doing.haml
 homepage: http://brettterpstra.com/project/doing/
 licenses:
 - MIT