zoi 0.0.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ccfa9bd2af8d9ab31bbdc514297d9365c38bc2421b2173093fe08fd8251d944
-  data.tar.gz: ba885cd33410899947a601f53750527d40099859bbd505e2f6950c47da6e447f
+  metadata.gz: d23241852fcfd819a4d44dd63b6880aeef2ec93ba9ed7f8dcf47bb65e16d30f7
+  data.tar.gz: 781a1cb431cba40751192af7ff44516a03882f266272043c74606f5c7c2f5c32
 SHA512:
-  metadata.gz: 595012ed030fcaafc09abffb41e3f02632c3249676ba14384abcf37a032709c2a2eabc39d2b4931a8ca2dbed10949d285dc3a93f4d905152c3ac85dae9e5938d
-  data.tar.gz: f1a8b96908b12885b34697ab56580e08d81c4b51fdd3923c0cd132776b1f3531a512dc8ee5a213319fb5be4fb836f145b8212260df19c96392094582c46b421a
+  metadata.gz: 62fae3694797624b563eef4eda673a6de6f667f713c94b45c44316bbe3a2e9283eca30047e7c6623d1c2a394edd4aae66ce5556c515a2459fef90d204f0a1259
+  data.tar.gz: 89cdc3fbf4b3930370a66eff38df225adaa9cc9f1ffa6ebebf64474071ea37af7dcd90f68c10680c3eb0fc8860018447f6c7736be7e08dfa9ee6b21b1b842e37

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest]
+        ruby: [2.7, 3.0]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: ruby test/*.rb

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 pkg
+tmp/

data/CHANGELOG.adoc

@@ -0,0 +1,19 @@
+== 0.1.3 (September 15, 2021)
+
+=== Enhancements
+* Add `memo` command https://github.com/9sako6/zoi/pull/11[#11]
+
+== 0.1.2 (September 11, 2021)
+
+=== Enhancements
+* Add `root` command https://github.com/9sako6/zoi/pull/8[#8]
+
+== 0.1.1 (July 29, 2021)
+
+=== Bug Fixes
+* Fix load error of 'pathname' library https://github.com/9sako6/zoi/pull/3[#3]
+
+== 0.1.0 (July 29, 2021)
+
+=== Enhancements
+* Add basic commands https://github.com/9sako6/zoi/pull/2[#2]

data/Gemfile

@@ -1,7 +1,16 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
+gem 'thor'
+
 group :development do
   gem 'rake', '~> 12.0'
 end
+
+group :test do
+  gem 'mocha'
+  gem 'timecop'
+end

data/README.adoc

@@ -0,0 +1,65 @@
+= zoi(1)
+
+== NAME
+
+zoi - Manage snippets
+
+== DESCRIPTION
+
+‘zoi' provides a way to organize snippets. When you create a new file by `create` command, zoi makes the file under ~/zoi. When you execute `open` command, zoi create a new file and open it with your editor. If you want to list all files or all directory in ~/zoi, use `list` command.
+
+[verse]
+zoi create ruby/foo.rb
+# ~/zoi/ruby/foo.rb is created.
+
+== SYNOPSIS
+
+[verse]
+zoi create <filepath>
+zoi open <filepath>
+zoi list [-d]
+zoi memo
+zoi root
+zoi help
+
+== COMMANDS
+
+create::
+  Create a new file under zoi root directory. If the file already exists, the file isn't created. +
+  In all cases, the full path of the file is printed to stdout. +
+  For example: `zoi create memo/20210101.md`
+
+open::
+  Execute `create` command and open the file with the editor specified by `$EDITOR`. To open a file, set `$EDITOR`. +
+  For example: `EDITOR=code zoi open memo/20210101.md`
+
+list::
+  List all files under zoi root directory. +
+  With '-d' option, list all directories under zoi root directory.
+
+memo::
+  Create today's memo file and open the file with the editor specified by `$EDITOR`. +
+  The file name is `YYYY-MM-DD.md` +
+  For example: `EDITOR=code zoi open memo/20210101.md` +
+  If it's September 9th in 2021, a new file ~/zoi/2021-09-09.md is created and is opend in VSCode.
+
+root::
+  Print zoi root directory.
+
+help::
+  Print a brief help message.
+
+== INSTALLATION
+
+    gem install zoi
+
+== EXAMPLES
+
+* Change directories
++
+[verse]
+cd $(zoi list -d | fzf)
+
+== AUTHOR
+
+https://github.com/9sako6[9sako6]

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/exe/zoi

@@ -1,13 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'zoi'
 
-case ARGV[0]
-when '-l', '--list'
-  puts Zoi.list
-when '-t', '--today'
-  puts Zoi.today_file
-when nil
-  new_file_path = Zoi.create
-  new_file_path.nil? ? nil : (puts new_file_path)
-end
+args = File.pipe?(STDIN) ? ARGV + STDIN.gets.chomp.split : ARGV
+
+Zoi::CLI.start(args)

data/lib/zoi/cli.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'fileutils'
+require 'find'
+require 'open3'
+require 'pathname'
+require 'thor'
+
+module Zoi
+  ROOT_DIR_NAME = 'zoi'
+
+  class CLI < Thor
+    desc 'create <filepath>', 'Create a new file under zoi root directory.'
+    def create(file_path)
+      return if file_path.nil?
+
+      puts create_file(file_path)
+    end
+
+    desc 'open <filepath>', 'Execute `create` command and open the file with the editor specified by $EDITOR. For example: `EDITOR=code zoi open foobar.rb`'
+    def open(file_path)
+      return if editor.nil? || file_path.nil?
+
+      created_file_path = create_file(file_path)
+
+      puts created_file_path
+
+      open_file(created_file_path)
+    end
+
+    desc 'list [-d]', 'List all files under zoi root directory.'
+    option 'd', type: :boolean
+    def list
+      only_directory = options['d']
+
+      puts(Find.find(root_path).select { |path| only_directory ? File.directory?(path) : File.file?(path) })
+    end
+
+    desc 'memo', "Create today's memo file and open the file with the editor specified by `$EDITOR`."
+    def memo
+      return if editor.nil?
+
+      created_file_path = create_file("#{Date.today}.md")
+
+      puts created_file_path
+
+      open_file(created_file_path)
+    end
+
+    desc 'root', 'Print zoi root directory.'
+    def root_command
+      puts root_path
+    end
+
+    # NOTE: Resolve the following error.
+    #       `"root" is a Thor reserved word and cannot be defined as command`
+    map 'root' => 'root_command'
+
+    no_tasks do
+      def editor
+        @editor ||= ENV['EDITOR']
+      end
+
+      def create_file(file_path)
+        file_full_path = File.join(root_path, file_path)
+
+        return file_full_path if File.exist?(file_full_path)
+
+        dir_path = File.join(root_path, File.dirname(file_path))
+
+        FileUtils.mkdir_p(dir_path)
+        FileUtils.touch(file_full_path)
+        file_full_path
+      end
+
+      def open_file(file_path)
+        system(editor, file_path)
+      end
+
+      def root_path
+        @root_path ||= Pathname(Dir.home).join(ROOT_DIR_NAME).to_s
+      end
+    end
+  end
+end

data/lib/zoi/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zoi
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.3'
 end

data/lib/zoi.rb

@@ -1,43 +1,6 @@
-require 'date'
-require 'fileutils'
-require_relative 'zoi/version'
-
-module Zoi
-  class Error < StandardError; end
-
-  class << self
-    def create
-      FileUtils.mkdir_p(root_path)
-
-      return if File.exist?(today_file)
-
-      File.open(today_file, 'w') do |f|
-        f.puts "# #{today}"
-      end
-
-      today_file
-    end
+# frozen_string_literal: true
 
-    def list
-      Dir.glob("#{root_path}/*")
-    end
-
-    def today_file
-      File.join(root_path, file_name)
-    end
-
-    private
-
-    def file_name
-      "#{today}.md"
-    end
-
-    def today
-      Date.today.strftime('%Y%m%d')
-    end
+require_relative 'zoi/version'
+require_relative 'zoi/cli.rb'
 
-    def root_path
-      File.join(Dir.home, name.downcase)
-    end
-  end
-end
+module Zoi; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.3
 platform: ruby
 authors:
 - 9sako6
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies: []
 description: management snippets
 email:
@@ -18,16 +18,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- CHANGELOG.md
+- CHANGELOG.adoc
 - Gemfile
 - LICENSE
-- README.md
+- README.adoc
 - Rakefile
-- bin/console
-- bin/setup
 - exe/zoi
 - lib/zoi.rb
+- lib/zoi/cli.rb
 - lib/zoi/version.rb
 - zoi.gemspec
 homepage: https://github.com/9sako6/zoi

data/README.md

@@ -1,35 +0,0 @@
-# Zoi
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zoi`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'zoi'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install zoi
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zoi.

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'zoi'
-
-# 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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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