zoi 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcf9ada58a6c4d261304bf85581a811ca84745c1820e7f08e1141cb11f1605d8
-  data.tar.gz: e3edf9ec712d10b3edc73b299d5144c1d6befd3e1d25810467ef5cffaf26577f
+  metadata.gz: dc7a5b36e248634f14b08f1253f8805a0031adeb4a1fc8de3204f2c5fb5ead75
+  data.tar.gz: 570d172ae486c9804f395daca114b5c5d9287ea29770550ff4e392a4aa1c359a
 SHA512:
-  metadata.gz: 572cf635f41310c624aa38ae43dbe1b34cdf10830bcadc7367334eb463806ffc2783e847f60a5929d5014d2f7ccba895f99c37ffc751e5b676213b5b2c630e9e
-  data.tar.gz: ca5cfb874c5e37f3028b114b5d6c77141d9a0de891f833dca34db903df10d6d10915849a49e413e2d662d9be14427e3c9bb45200fa5a61e395027483ae834f89
+  metadata.gz: c43de2e301a4abd44d9e490c3b6285e45ba63cc2bd778e8020172519cc9ec99cdaa94855346435394af8d86ab562c9ab9287805e2118735e05cbca997b2a19cc
+  data.tar.gz: 259ab4bf3026b5f9b7161d51c26f75eb4c9c4f1559860a6a7d68c008a81adf3bf1afaf606a9c54b3ebb2d86bfb4229493685eb4660a2ebee64ee007f5cd86de5

data/.github/workflows/test.yml

@@ -17,5 +17,7 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
       - name: Install dependencies
         run: bundle install
+      - name: RuboCop
+        run: bundle exec rubocop
       - name: Run tests
         run: ruby test/*.rb

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml

data/CHANGELOG.adoc

@@ -1,4 +1,36 @@
-== 0.1.0 (July 7, 2021)
+== 0.1.4 (January 6, 2022)
+
+=== Enhancements
+* Add a configuration file, __~/.zoirc.json__ https://github.com/9sako6/zoi/pull/17[#17]
+** You can optionally save the settings used by zoi to a configuration file, __~/.zoirc.json__. +
+The type of editor used by zoi can be specified in the __~/.zoirc.json__ file. +
+The following is the example of the __~/.zoirc.json__ file.
++
+[source,json]
+----
+{
+  "editor": "code"
+}
+----
++
+In that case, there is no need to pass the `EDITOR` environment variable at runtime.
+
+== 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,15 +1,17 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'thor'
+gem "thor"
 
 group :development do
-  gem 'rake', '~> 12.0'
+  gem "rake", "~> 12.0"
+  gem "rubocop-shopify", require: false
 end
 
 group :test do
-  gem 'mocha'
+  gem "mocha"
+  gem "timecop"
 end

data/README.adoc

@@ -6,10 +6,10 @@ zoi - Manage snippets
 
 == DESCRIPTION
 
-Manage snippets.
+‘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 c ruby/foo.rb
+zoi create ruby/foo.rb
 # ~/zoi/ruby/foo.rb is created.
 
 == SYNOPSIS
@@ -18,6 +18,7 @@ zoi c ruby/foo.rb
 zoi create <filepath>
 zoi open <filepath>
 zoi list [-d]
+zoi memo
 zoi root
 zoi help
 
@@ -25,15 +26,23 @@ zoi help
 
 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.
+  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`. For example: `EDITOR=code zoi open foobar.rb`
+  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 with the VSCode editor.
+
 root::
   Print zoi root directory.
 
@@ -44,14 +53,29 @@ help::
 
     gem install zoi
 
-== EXAMPLES
+== CONFIGURATION
 
-Open today's memo file in VSCode.
+You can optionally save the settings used by zoi to a configuration file, __~/.zoirc.json__.
 
-[verse]
-code $(date "+%Y%m%d.adoc" | zoi c)
+The type of editor used by zoi can be specified in the __~/.zoirc.json__ file.
+
+The following is the example of the __~/.zoirc.json__ file.
+
+[source,json]
+----
+{
+  "editor": "code"
+}
+----
 
-A new file ~/zoi/20210727.adoc is created and is opend in VSCode.
+In that case, there is no need to pass the `EDITOR` environment variable at runtime.
+
+== EXAMPLES
+
+* Change directories
++
+[verse]
+cd $(zoi list -d | fzf)
 
 == AUTHOR
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/exe/zoi

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'zoi'
+require "zoi"
 
-args = File.pipe?(STDIN) ? ARGV + STDIN.gets.chomp.split : ARGV
+args = File.pipe?($stdin) ? ARGV + $stdin.gets.chomp.split : ARGV
 
 Zoi::CLI.start(args)

data/lib/zoi/cli.rb

@@ -1,22 +1,29 @@
 # frozen_string_literal: true
 
-require 'fileutils'
-require 'find'
-require 'open3'
-require 'thor'
+require "date"
+require "fileutils"
+require "find"
+require "json"
+require "open3"
+require "pathname"
+require "thor"
 
 module Zoi
-  ROOT_DIR_NAME = 'zoi'
+  ROOT_DIR_NAME = "zoi"
+  CONFIG_FILE_NAME = ".zoirc.json"
 
   class CLI < Thor
-    desc 'create <filepath>', 'Create a new file under zoi root directory.'
+    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`'
+    desc "open <filepath>", <<~DESCRIPTION
+      Execute `create` command and open the file with the editor specified by $EDITOR.
+      For example: `EDITOR=code zoi open foobar.rb`
+    DESCRIPTION
     def open(file_path)
       return if editor.nil? || file_path.nil?
 
@@ -27,17 +34,41 @@ module Zoi
       open_file(created_file_path)
     end
 
-    desc 'list [-d]', 'List all files under zoi root directory.'
-    option 'd', type: :boolean
+    desc "list [-d]", "List all files under zoi root directory."
+    option "d", type: :boolean
     def list
-      only_directory = options['d']
+      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']
+        if File.exist?(config_file_path)
+          load_envs_from_config_file
+        end
+
+        ENV["EDITOR"]
       end
 
       def create_file(file_path)
@@ -59,6 +90,18 @@ module Zoi
       def root_path
         @root_path ||= Pathname(Dir.home).join(ROOT_DIR_NAME).to_s
       end
+
+      def config_file_path
+        @config_file_path ||= Pathname(Dir.home).join(CONFIG_FILE_NAME).to_s
+      end
+
+      def config_json
+        @config_json ||= JSON.parse(File.open(config_file_path, "r", &:read))
+      end
+
+      def load_envs_from_config_file
+        ENV["EDITOR"] = config_json["editor"] unless ENV["EDITOR"]
+      end
     end
   end
 end

data/lib/zoi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zoi
-  VERSION = '0.1.0'
+  VERSION = "0.1.4"
 end

data/lib/zoi.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'zoi/version'
-require_relative 'zoi/cli.rb'
+require_relative "zoi/version"
+require_relative "zoi/cli"
 
 module Zoi; end

data/zoi.gemspec

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
-require_relative 'lib/zoi/version'
+require_relative "lib/zoi/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'zoi'
+  spec.name = "zoi"
   spec.version = Zoi::VERSION
-  spec.authors = ['9sako6']
-  spec.email = ['31821663+9sako6@users.noreply.github.com']
+  spec.authors = ["9sako6"]
+  spec.email = ["31821663+9sako6@users.noreply.github.com"]
 
-  spec.summary = 'management snippets'
-  spec.description = 'management snippets'
-  spec.homepage = 'https://github.com/9sako6/zoi'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.summary = "management snippets"
+  spec.description = "management snippets"
+  spec.homepage = "https://github.com/9sako6/zoi"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/9sako6/zoi'
-  spec.metadata['changelog_uri'] = 'https://github.com/9sako6/zoi'
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/9sako6/zoi"
+  spec.metadata["changelog_uri"] = "https://github.com/9sako6/zoi"
 
   # 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(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir = 'exe'
+  spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - 9sako6
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies: []
 description: management snippets
 email:
@@ -20,6 +20,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.adoc
 - Gemfile
 - LICENSE