lexdrill 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c02d9aa7303198e675b647958c287d690303a54e62891a52da016a094ab061e
-  data.tar.gz: 4eb14a5d4f5803b7da36df2f3dc273609f36e61f1477c6bb53aa891959be9d67
+  metadata.gz: 5ee9e8bd1de6b7fc437375184394a0ce42d61d9648320e6a31e83bf575cfc885
+  data.tar.gz: 27836a51638dbd08eb53a1d6f6808d94a0fb27c8e4b93cd831e96c2f5b0abe64
 SHA512:
-  metadata.gz: 365127d5d9aa2829ccbb570e200504da60064e188b27327d5a25de815e51581f4714d683d5d7866ac060dbc8e96d60c50b3c27ae5cc5e22e0c62af7a99302d72
-  data.tar.gz: cf8292e88bce78b4bf4d3db8d5bb5e39643b5a22b255148b3232071022e1274355305ceec5775270b541f394c89ca7544402f81985229f59c95c9ab61c02c8fe
+  metadata.gz: cb860ea6fb40050205abbbdc2078d1a3e5b4f624629bb1b769a33c7bd1de3e22452d65265017cd0e7597bde5d934b04c568e96ab8f2643678392dfe86a8e2dc6
+  data.tar.gz: edbe4b9f27ced36534b9f3816840feb9216728288077af785292b12015d765db0c96170a0f8f79dc9182926323b3404517abd237ff51b47747901fb4e93632a7

data/README.md

@@ -1,5 +1,29 @@
 # lexdrill
-rubygems_2b77e405d9e5e8b74a8f60a79a57b5a7b3d4a44702507687
-mkdir -p ~/.gem
-printf -- '---\n:rubygems_api_key: rubygems_2b77e405d9e5e8b74a8f60a79a57b5a7b3d4a44702507687\n' > ~/.gem/credentials
-chmod 0600 ~/.gem/credentials
+
+lexdrill prints a vocabulary word or phrase on demand, tracking how often each one has been shown.
+
+## Installation
+
+```bash
+gem install lexdrill
+```
+
+### `lexdrill: command not found` after install?
+
+This happens when the gem's executable directory isn't on your `PATH` — common with a
+plain system Ruby (no rbenv/rvm). Fix it in one step:
+
+**bash**
+```bash
+echo "export PATH=\"$(ruby -e 'puts Gem.bindir'):\$PATH\"" >> ~/.bashrc
+source ~/.bashrc
+```
+
+**zsh**
+```zsh
+echo "export PATH=\"$(ruby -e 'puts Gem.bindir'):\$PATH\"" >> ~/.zshrc
+source ~/.zshrc
+```
+
+Using an rbenv-managed Ruby? Run `rbenv rehash` instead. Using rvm? You shouldn't hit
+this — rvm keeps gem executable directories on `PATH` automatically.

data/lexdrill.gemspec

@@ -6,18 +6,18 @@ Gem::Specification.new do |spec|
   spec.name = "lexdrill"
   spec.version = Lexdrill::VERSION
   spec.authors = ["Siarhei Kisliak"]
-  spec.email = ["siarhei.kisliak@airslate.com"]
+  spec.email = ["kislak7@gmail.com"]
 
   spec.summary = "Vocabulary drilling in your terminal."
   spec.description = "lexdrill prints a vocabulary word or phrase on demand, tracking how often " \
                      "each one has been shown."
-  spec.homepage = "https://github.com/skisliak/lexdrill"
+  spec.homepage = "https://github.com/kislak/lexdrill"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["rubygems_mfa_required"] = "false"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files = Dir.chdir(__dir__) do
     Dir["lib/**/*.rb"] + Dir["bin/*"] + %w[README.md LICENSE.txt lexdrill.gemspec Gemfile]

data/lib/lexdrill/cli.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Subcommand dispatcher for the `lexdrill` executable.
 class Lexdrill::CLI
   COMMANDS = {
     print_version: %w[version --version -v],
-    print_help: %w[help --help -h]
+    print_help: %w[help --help -h],
+    run_next: %w[next]
   }.freeze
 
   def self.start(argv = ARGV)
@@ -39,10 +39,24 @@ class Lexdrill::CLI
       Usage:
         lexdrill version   Print the gem version
         lexdrill help      Show this help
+        lexdrill next      Print the current word and advance
     HELP
     0
   end
 
+  def run_next
+    word = Lexdrill::WordList.next
+    return print_no_words(Lexdrill::WordList::PATH) unless word
+
+    puts word
+    0
+  end
+
+  def print_no_words(path)
+    warn "lexdrill: no words found in #{path}"
+    1
+  end
+
   def print_unknown_command(command)
     warn "lexdrill: unknown command #{command.inspect}"
     print_help

data/lib/lexdrill/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lexdrill::Config
+  FILENAME = ".drill.txt"
+  COUNTER_FILENAME = ".drill.counter"
+
+  def self.dir_path
+    cwd = Dir.pwd
+    cwd if File.exist?(File.join(cwd, FILENAME))
+  end
+
+  def self.base_path
+    ENV.fetch("LEXDRILL_PATH", nil) || dir_path || Dir.home
+  end
+
+  DRILL_PATH = File.join(base_path, FILENAME)
+  COUNTER_PATH = File.join(base_path, COUNTER_FILENAME)
+end

data/lib/lexdrill/counter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class Lexdrill::Counter
+  attr_reader :path
+
+  def initialize(path)
+    @path = path
+  end
+
+  def value
+    return 0 unless File.exist?(path)
+
+    File.read(path).strip.to_i
+  end
+
+  def increment
+    File.write(path, (value + 1).to_s)
+  end
+
+  def reset
+    File.write(path, "0")
+  end
+
+  # The current value, unless it's out of bounds for the given size, in
+  # which case it resets to 0 first.
+  def bounded_value(size)
+    current = value
+    return current if current < size
+
+    reset
+    0
+  end
+end

data/lib/lexdrill/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lexdrill
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/lexdrill/word_list.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Reads vocabulary words/phrases from a `.drill.txt` file, one per line, and
+# advances a persisted counter to show "the current word" each time.
+class Lexdrill::WordList
+  PATH = Lexdrill::Config::DRILL_PATH
+  COUNTER_PATH = Lexdrill::Config::COUNTER_PATH
+
+  def self.words
+    @words ||= File.exist?(PATH) && File.readlines(PATH).map(&:strip).reject(&:empty?)
+    @words ||= []
+  end
+
+  def self.next
+    return nil if words.empty?
+
+    words[take_index(words.size)]
+  end
+
+  def self.take_index(size)
+    counter = Lexdrill::Counter.new(COUNTER_PATH)
+    index = counter.bounded_value(size)
+    counter.increment
+    index
+  end
+end

data/lib/lexdrill.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "lexdrill/version"
+require_relative "lexdrill/config"
+require_relative "lexdrill/counter"
+require_relative "lexdrill/word_list"
 require_relative "lexdrill/cli"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lexdrill
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Siarhei Kisliak
@@ -13,7 +13,7 @@ dependencies: []
 description: lexdrill prints a vocabulary word or phrase on demand, tracking how often
   each one has been shown.
 email:
-- siarhei.kisliak@airslate.com
+- kislak7@gmail.com
 executables:
 - lexdrill
 extensions: []
@@ -26,14 +26,17 @@ files:
 - lexdrill.gemspec
 - lib/lexdrill.rb
 - lib/lexdrill/cli.rb
+- lib/lexdrill/config.rb
+- lib/lexdrill/counter.rb
 - lib/lexdrill/version.rb
-homepage: https://github.com/skisliak/lexdrill
+- lib/lexdrill/word_list.rb
+homepage: https://github.com/kislak/lexdrill
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/skisliak/lexdrill
-  source_code_uri: https://github.com/skisliak/lexdrill
-  rubygems_mfa_required: 'false'
+  homepage_uri: https://github.com/kislak/lexdrill
+  source_code_uri: https://github.com/kislak/lexdrill
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: