wb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 308d477d5155abf0f41976ad5e9b74b4bd1e7d510d1d85221a0bf9e9470126c5
+  data.tar.gz: c445711c39f5e9b04208351353714146daf65095c76997329bfd176a8888ee33
+SHA512:
+  metadata.gz: 259cbd2a351fc1abf1eaffa06c463e5baa3415605af0ae726d6dfab96fc9be52ce4cf88bc1feae60cb4fe83ec1bcee0d7367bb33ac0931afc64f5f5885f6e104
+  data.tar.gz: f907e1e4c066744452ce81e689995127ad05ca7bd0f11f635d0ec28ae49b3d665251330bc6ebe28403c46bb6a1e0aaaf171f51703017233748c2af8d9362f307

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in wb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    wb (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pry
+  rake
+  rspec (~> 3.0)
+  wb!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Juanito Fatas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# WB -- Software Engineers's Workbook
+
+[Background reading: Lab Notebooking for the Software Engineer](https://blog.nelhage.com/2010/06/lab-notebooking-for-the-software-engineer/)
+
+## Installation
+
+    $ gem install wb
+
+## Usage
+
+Set `wb` up first:
+
+```
+$ wb setup # wb init + wb ignore
+```
+
+This will create a config yaml at `~/.workbookrc`:
+
+```yaml
+# Auto generated by wb 1.0.0
+workbook:
+  working_hours: "9-17"
+  personal: "~/Dropbox/workbooks/personal.md"
+  work: "~/Dropbox/workbooks/work.md"
+  project:
+    note_folder: ".note"
+```
+
+To open a workbook:
+
+```
+wb
+```
+
+This will open workbook based on the working hour set in `~/.workbookrc`.
+
+Inside working hour `wb` equals to:
+
+```
+wb work
+```
+
+Outside working hour `wb` equals to:
+
+```
+wb personal
+```
+
+Create a new workbook in the project you are working:
+
+```
+wb new
+```
+
+by default it creates a markdown workbook using today's date:
+
+```
+2018-09-24.md
+```
+
+The date could be overrided in `~/.workbookrc`, either at `workbook` or `project` level:
+
+Based on [Ruby's `strftime`](https://ruby-doc.org/stdlib-2.5.1/libdoc/date/rdoc/DateTime.html#method-i-strftime):
+
+```
+workbook:
+  date_format: %c
+```
+
+```
+workbook:
+  project:
+    date_format: %D
+```
+
+The extension could be overrided in `~/.workbookrc`, either at `workbook` or `project` level:
+
+```
+workbook:
+  extension: rdoc
+```
+
+```
+workbook:
+  project:
+    extension: txt
+```
+
+Invoking `wb new` again will use your editor `$EDITOR` to open the existing workbook.
+
+You can also create a workbook with custom name under project by:
+
+```
+(on branch fix-nasty-bugs)
+git rev-parse --abbrev-ref HEAD | xargs wb new
+
+# will create a new note named under {project.note_folder}:
+# 2018-09-24-fix-nasty-bugs.md
+```
+
+Opening local / global notebooks by:
+
+```
+wb open
+
+0: .note/2018-09-23.md
+1: .note/2018-09-24.md
+2: ~/Dropbox/workbooks/personal.md
+3: ~/Dropbox/workbooks/work.md
+```
+
+Type in the notebook number you want to open.
+
+If you remember the notebook name by heart, supply `NAME` to `wb open`:
+
+```
+# both works
+wb open .note/2018-09-23.md
+wb open 2018-09-23.md # opens .note/2018-09-23.md
+wb open personal.md # ~/Dropbox/workbooks/personal.md
+```
+
+Full documentation by `wb help`:
+
+```
+wb init       Initialize wb config yaml file
+wb ignore     Add {project.note_folder} to global gitignore
+wb setup      wb init + wb ignore
+
+wb config     Open wb config file
+
+wb            Open global notebook based on {working_hours}
+wb personal   Open global personal notebook
+wb work       Open global work notebook
+
+wb open       Open from all notes in {project.note_folder} and global notes
+wb open NAME  Open note by NAME
+
+wb new        Create/Open note of name {date_format}.{extension} under {project.note_folder}
+wb new NAME   Create note by {date_format}.NAME under {project.note_folder}
+```
+
+Thank you for using `wb`.
+
+Feedback and improvement are welcome!
+
+## License, Contributor's Guidelines, and Credits
+
+- MIT license
+- [Moya Contributors Guidelines][moya] which TLDR: means we give out push access easily and often.
+- Notebook idea by [Nelson Elhage](https://blog.nelhage.com/about/)
+
+[mit]: https://opensource.org/licenses/MIT
+[moya]: https://github.com/Moya/contributors

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/hack

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$"\n\t"
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/wb

@@ -0,0 +1,185 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wb"
+
+# Exit cleanly from an early interrupt
+Signal.trap("INT") { abort }
+
+class HelpCommand
+  def self.name
+    @name ||= "help"
+  end
+
+  def run(*)
+    $stdout.puts(<<~HELP)
+      wb init       Initialize wb config yaml file
+      wb ignore     Add {project.note_folder} to global gitignore
+      wb setup      wb init + wb ignore
+
+      wb config     Open wb config file
+
+      wb            Open global notebook based on {working_hours}
+      wb personal   Open global personal notebook
+      wb work       Open global work notebook
+
+      wb open       Open from all notes in {project.note_folder} and global notes
+      wb open NAME  Open note by NAME
+
+      wb new        Create/Open note of name {date_format}.{extension} under {project.note_folder}
+      wb new NAME   Create note by {date_format}.NAME under {project.note_folder}
+    HELP
+  end
+end
+
+class InitCommand
+  def self.name
+    @name ||= "init"
+  end
+
+  def run(*)
+    unless File.exist?(WB.default_config)
+      File.open(WB.default_config, "w") do |file|
+        file.puts WB::ConfigTemplate.content
+      end
+      $stdout.puts %Q(#{WB.default_config} created!)
+    end
+  end
+end
+
+class IgnoreCommand
+  def self.name
+    @name ||= "ignore"
+  end
+
+  def run(*)
+    gitignore_global = File.join(Etc.getpwuid.dir, ".gitignore_global")
+
+    unless IO.read(gitignore_global).include?(breadcrumb)
+      WB::Shell.append(gitignore_global) do |file|
+        file.puts("\n# ignore project notes by #{breadcrumb}")
+        file.puts("/.note/")
+      end
+    end
+  end
+
+  private
+
+  def breadcrumb
+    "https://github.com/juanitofatas/wb"
+  end
+end
+
+class SetupCommand
+  def self.name
+    @name ||= "setup"
+  end
+
+  def run(*)
+    $stdout.puts "wb init"
+    InitCommand.new.run
+
+    $stdout.puts "wb ignore"
+    IgnoreCommand.new.run
+
+    $stdout.puts "setup completed."
+  end
+end
+
+class DefaultCommand
+  def self.name
+    @name ||= ""
+  end
+
+  def run(*)
+    if WB::Day.working?
+      WB::Shell.open_file(WB.config.work_workbook)
+    else
+      WB::Shell.open_file(WB.config.personal_workbook)
+    end
+  end
+end
+
+class PersonalCommand
+  def self.name
+    @name ||= "personal"
+  end
+
+  def run(*)
+    WB::Shell.open_file(WB.config.personal_workbook)
+  end
+end
+
+class WorkCommand
+  def self.name
+    @name ||= "work"
+  end
+
+  def run(*)
+    WB::Shell.open_file(WB.config.work_workbook)
+  end
+end
+
+class OpenCommand
+  def self.name
+    @name ||= "open"
+  end
+
+  def run(filename)
+    if filename
+      note = WB::Note.find_note(filename)
+      if note
+        WB::Shell.open_file(note.path)
+      else
+        $stdout.puts "Cannot find #{filename}, please double check."
+      end
+    else
+      WB::Note.list_notes
+      note_number = WB::Shell.getc
+      note = WB::Note.find_by_number(note_number)
+      if note
+        WB::Shell.open_file(note.path)
+      else
+        $stdout.puts "Cannot pick #{note_number}, please double check."
+      end
+    end
+  end
+end
+
+class NewCommand
+  def self.name
+    @name ||= "new"
+  end
+
+  def run(name)
+    filename = WB::Project.new_note(name)
+    unless File.exist?(filename)
+      WB::Shell.create_file(filename)
+    end
+    WB::Shell.open_file(filename)
+  end
+end
+
+class ConfigCommand
+  def self.name
+    @name ||= "config"
+  end
+
+  def run(*)
+    WB::Shell.open_file(WB.config.path)
+  end
+end
+
+commands = [
+  HelpCommand,
+  InitCommand,
+  IgnoreCommand,
+  SetupCommand,
+  DefaultCommand,
+  PersonalCommand,
+  WorkCommand,
+  OpenCommand,
+  NewCommand,
+  ConfigCommand,
+]
+WB::CLI.new(commands).run(arguments: ARGV)

data/lib/wb.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require "etc"
+
+require "wb/version"
+require "wb/config"
+require "wb/cli"
+require "wb/project"
+require "wb/shell"
+require "wb/day"
+require "wb/config_template"
+
+module WB
+  def self.default_config
+    File.join(Etc.getpwuid.dir, ".workbookrc")
+  end
+
+  def self.config(path: default_config)
+    @config ||= Config.new(path)
+  end
+end

data/lib/wb/cli.rb

@@ -0,0 +1,29 @@
+module WB
+  class CLI
+    def initialize(commands)
+      @commands = commands
+    end
+
+    def run(arguments: ARGV)
+      command = find_command(arguments[0])
+      command.run(arguments[1])
+    end
+
+    private
+
+    attr_reader :commands
+
+    def find_command(name)
+      command = find_command_by_name(name) || default_command
+      command.new
+    end
+
+    def find_command_by_name(name)
+      commands.find { |command| command.name == name }
+    end
+
+    def default_command
+      commands.find { |command| command.name == "" }
+    end
+  end
+end

data/lib/wb/config.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "wb/note"
+require "wb/filename"
+
+module WB
+  class Config
+    attr_reader :path
+
+    def initialize(config_path)
+      @path = config_path
+      @config = YAML.safe_load(IO.read(config_path))
+    end
+
+    def notes
+      local_notes = Dir[File.join(WB.config.project_root, "*")]
+      global_notes = [WB.config.personal_workbook, WB.config.work_workbook]
+
+      [*local_notes, *global_notes].each_with_index.map do |note, index|
+        WB::Note.new(note, index)
+      end
+    end
+
+    def working_hours
+      @working_hours ||= workbook.fetch("working_hours").split("-")
+    end
+
+    def personal_workbook
+      @personal_workbook ||= workbook.fetch("personal")
+    end
+
+    def work_workbook
+      @work_workbook ||= workbook.fetch("work")
+    end
+
+    def project_root
+      @project_root ||= project.fetch("note_folder")
+    end
+
+    def project_date_format
+      @project_date_format ||= begin
+        date_format = fetch_config(key: "date_format", default: DEFAULT_DATE_FORMAT)
+        Filename.generate(date_format)
+      end
+    end
+
+    def extension
+      @extension ||= begin
+        fetch_config(key: "extension", default: DEFAULT_EXTENSION_FORMAT)
+      end
+    end
+
+    private
+
+    attr_reader :config
+
+    DEFAULT_DATE_FORMAT = "%F"
+    private_constant :DEFAULT_DATE_FORMAT
+
+    DEFAULT_EXTENSION_FORMAT = "md"
+    private_constant :DEFAULT_EXTENSION_FORMAT
+
+    def workbook
+      @_workbook ||= config.fetch("workbook")
+    end
+
+    def project
+      @_project ||= workbook.fetch("project")
+    end
+
+    def fetch_config(key:, default:)
+      project.fetch(key) do
+        workbook.fetch(key) do
+          default
+        end
+      end
+    end
+  end
+end

data/lib/wb/config_template.rb

@@ -0,0 +1,18 @@
+module WB
+  class ConfigTemplate
+    def self.content
+      CONTENT
+    end
+
+    CONTENT = <<~WORKBOOKRC
+      # Auto generated by wb #{WB::VERSION}
+      workbook:
+        working_hours: "9-17"
+        personal: "~/Dropbox/workbooks/personal.md"
+        work: "~/Dropbox/workbooks/work.md"
+        project:
+          note_folder: ".note"
+    WORKBOOKRC
+    private_constant :CONTENT
+  end
+end

data/lib/wb/day.rb

@@ -0,0 +1,25 @@
+require "time"
+
+module WB
+  class Day
+    def self.working?
+      now = Time.now
+      date = now.strftime("%Y-%m-%d")
+      from, to = WB.config.working_hours
+      start_time = TimeUtils.get_beginning_of(from, within: date)
+      end_time = TimeUtils.get_end_of(to, within: date)
+
+      now.between?(start_time, end_time)
+    end
+  end
+
+  class TimeUtils
+    def self.get_beginning_of(hour, within:)
+      Time.parse("#{within} #{hour}:00:00")
+    end
+
+    def self.get_end_of(hour, within:)
+      Time.parse("#{within} #{hour}:59:59")
+    end
+  end
+end

data/lib/wb/filename.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module WB
+  class Filename
+    def self.generate(format)
+      Time.now.strftime(format)
+    end
+  end
+end

data/lib/wb/note.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module WB
+  class Note
+    attr_reader :path, :number
+
+    def self.all
+      WB.config.notes
+    end
+
+    def self.find_by_number(number)
+      all.find { |note| note.number == number }
+    end
+
+    def self.find_by_full_path(full_path)
+      all.find { |note| note.path == full_path }
+    end
+
+    def self.find_by_basename(basename)
+      all.find { |note| File.basename(note.path) == basename }
+    end
+
+    def self.find_note(name)
+      find_by_full_path(name) || find_by_basename(name)
+    end
+
+    def self.list_notes
+      all.each { |note| $stdout.puts note }
+    end
+
+    def initialize(path, number)
+      @path = path
+      @number = number.to_s
+    end
+
+    def to_s
+      %Q(#{number}: #{path})
+    end
+  end
+end

data/lib/wb/project.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WB
+  class Project
+    def self.root
+      WB.config.project_root
+    end
+
+    def self.new_note(name)
+      filename = [WB.config.project_date_format, name].compact.join("-")
+      File.join(root, "#{filename}.#{WB.config.extension}")
+    end
+  end
+end

data/lib/wb/shell.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module WB
+  class Shell
+    def self.run(*commands)
+      $stdout.puts commands.join(" ")
+      system *commands
+    end
+
+    def self.mkdir_p_touch(path)
+      directory = File.dirname(path)
+      filename = File.basename(path)
+      unless File.exist?(directory)
+        FileUtils.mkdir_p(directory)
+      end
+      FileUtils.touch(filename)
+      $stdout.puts "#{path} created"
+    end
+
+    def self.create_file(path)
+      mkdir_p_touch(path)
+      path
+    end
+
+    def self.open_file(path, editor: ENV["EDITOR"])
+      run(editor, path)
+    end
+
+    def self.getc
+      $stdin.getc
+    end
+
+    def self.append(path)
+      file = File.open(path, "a")
+      yield file
+    ensure
+      $stdout.puts "Wrote to #{file.path}"
+      file.close
+    end
+  end
+end

data/lib/wb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WB
+  VERSION = "1.0.0"
+end

data/wb.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "wb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "wb"
+  spec.version       = WB::VERSION
+  spec.authors       = ["Juanito Fatas"]
+  spec.email         = ["katehuang0320@gmail.com"]
+
+  spec.summary       = %q{workbook}
+  spec.description   = %q{keep notes}
+  spec.homepage      = "https://github.com/JuanitoFatas/wb"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: wb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juanito Fatas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: keep notes
+email:
+- katehuang0320@gmail.com
+executables:
+- wb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hack
+- bin/setup
+- exe/wb
+- lib/wb.rb
+- lib/wb/cli.rb
+- lib/wb/config.rb
+- lib/wb/config_template.rb
+- lib/wb/day.rb
+- lib/wb/filename.rb
+- lib/wb/note.rb
+- lib/wb/project.rb
+- lib/wb/shell.rb
+- lib/wb/version.rb
+- wb.gemspec
+homepage: https://github.com/JuanitoFatas/wb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: workbook
+test_files: []