sesame-cli 0.1.0 → 0.2.0

data/lib/sesame/jinn.rb

@@ -1,27 +1,40 @@
+# frozen_string_literal: true
+
 require 'highline/import'
 require 'i18n'
 require 'clipboard'
 
 module Sesame
+  # The Jinn class is wholly responsible for interacting with the terminal.
   class Jinn
+    # Pass in parsed command-line options as a Slop instance.
     def initialize(opts)
+      I18n.load_path = Dir[File.join(File.dirname(__FILE__), 'lang', '*yml')]
       @opts = opts
+      _config
       _parse
       _welcome
       @sesame = Cave.new(@opts[:path])
-      I18n.load_path = Dir[File.join(File.dirname(__FILE__), 'lang', '*yml')]
     rescue Fail => e
       _error(e.message)
     end
 
+    # Process the users request, possibly starting an interactive session.
     def process!
-      was_locked = false
+      return if @sesame.nil?
+      @was_locked = false
+      raise Fail, 'Cannot lock and expunge simultaneously' if @opts.lock? && @opts.expunge?
       if @sesame.exists?
-        @sesame.forget if @sesame.locked? && @opts.expunge?
+        raise Fail, 'Please remove the cave before attempting to reconstruct' if @opts.reconstruct?
+        raise Fail, 'Cannot expunge lock; it doesn\'t exist' if @opts.expunge? && !@sesame.locked?
+        raise Fail, 'Please specify a command (or use interactive mode)' if !@opts.interactive? && @opts[:command].nil? && !@opts.lock? && !@opts.expunge?
+        if @sesame.locked? && @opts.expunge?
+          @sesame.forget
+          _warn('Lock expunged')
+        end
         if @sesame.locked?
           _unlock
-          @sesame.forget
-          was_locked = true
+          @was_locked = true
         else
           _open
         end
@@ -30,7 +43,7 @@ module Sesame
         _new
       end
       _process(@opts[:command])
-      if @opts[:command].nil? || @opts.interactive?
+      if @opts.interactive?
         loop do
           say("\n")
           break if _prompt
@@ -38,32 +51,62 @@ module Sesame
         if @opts.expunge?
           @sesame.close
         else
-          _lock(was_locked)
+          _lock
         end
-      elsif was_locked
-        _lock(true)
-      else
+      elsif @opts.expunge? || (!@was_locked && !@opts.lock?)
         @sesame.close
+      else
+        _lock
       end
     rescue Fail => e
       _error(e.message)
+    rescue SystemExit, Interrupt
+      _error('Stopped by user')
     end
 
     protected
 
     def _welcome
       return if @opts[:quiet]
-      say(HighLine.color(<<~EOS, :bold, :yellow))
+      say(HighLine.color(<<~WELCOME, :bold, :yellow))
         ╔═════════════════════════════════════╗
         ║ ┏━━━┓ ┏━━━┓ ┏━━━┓  ┏━┓  ┏┓ ┏┓ ┏━━━┓ ║
         ║ ┗━╋━┓ ┣━━┫  ┗━╋━┓ ┏┻━┻┓ ┃┗┳┛┃ ┣━━┫  ║
         ║ ┗━━━┛ ┗━━━┛ ┗━━━┛ ┗   ┛ ┗   ┛ ┗━━━┛ ║
         ╚═════════════════════════════════════╝
-      EOS
+      WELCOME
+    end
+
+    def _load_config(base = '.', name = '.sesamerc')
+      path = File.join(base, name)
+      if File.exist?(path)
+        JSON.parse(File.read(path), symbolize_names: true)
+      elsif name == '.sesamerc'
+        _load_config(base, 'sesame.cfg')
+      elsif base == '.'
+        _load_config(Dir.home)
+      else
+        {}
+      end
+    rescue JSON::ParserError
+      raise Fail, "#{path} is not valid JSON"
+    end
+
+    def _config
+      config = _load_config
+      _set_opt(:echo, config[:echo]) unless @opts.echo?
+      _set_opt(:interactive, config[:interactive]) unless @opts.interactive?
+      _set_opt(:quiet, config[:quiet]) unless @opts.quiet?
+      config[:path] ||= ENV.fetch('SESAME_PATH', '.')
+      _set_opt(:path, config[:path]) if @opts[:path].nil?
+      _set_opt(:path, File.expand_path(@opts[:path]))
     end
 
     def _parse
-      _set_path
+      unless Dir.exist?(@opts[:path])
+        _error("No such directory: #{@opts[:path]}")
+        exit 2
+      end
       _set_command('list') if @opts.list?
       _set_command('add') if @opts.add?
       _set_command('get') if @opts.get?
@@ -71,32 +114,11 @@ module Sesame
       _set_command('delete') if @opts.delete?
     end
 
-    def _set_path
-      # set @opts[:path] if nil from .sesamerc and then $SESAME_PATH and then current dir
-      if @opts[:path].nil?
-        @opts[:path] = _load_config || ENV.fetch('SESAME_PATH', '.')
-      end
-      @opts[:path] = File.expand_path(@opts[:path])
-      unless Dir.exist?(@opts[:path])
-        say("No such directory: #{@opts[:path]}")
-        exit 2
-      end
-    end
-
-    def _load_config(base=".")
-      path = File.join(base, '.sesamerc')
-      if File.exist?(path)
-        File.read(path)
-      elsif base == '.'
-        _load_config(Dir.home)
-      end
-    end
-
     def _set_command(name)
       if @opts[:command].nil?
-        @opts[:command] = name
+        _set_opt(:command, name)
       else
-        say("Cannot execute command #{name}; #{@opts[:command]} already specified!")
+        _error("Cannot #{name} and #{@opts[:command]}")
         exit 2
       end
     end
@@ -115,104 +137,115 @@ module Sesame
       when :delete
         _delete
       else
-        _error
+        _error('Command not recognised')
       end
     end
 
     def _prompt
       done = false
-      _info("prompt")
+      _info('prompt')
       choose do |menu|
         menu.prompt = "\n> "
         menu.shell = true
-        menu.choice(:list, "Display all of the services and users in your Sesame store.") do |command, args|
+        menu.choice(:list, 'Display all of the services and users in your Sesame store.') do |_, args|
           _set_opts(args)
           _list
         end
-        menu.choice(:add, "Add a new service and user to your Sesame store.") do |command, args|
+        menu.choice(:add, 'Add a new service and user to your Sesame store.') do |_, args|
           _set_opts(args)
           _add
         end
-        menu.choice(:get, "Retrieve the pass phrase for a service and user.") do |command, args|
+        menu.choice(:get, 'Retrieve the pass phrase for a service and user.') do |_, args|
           _set_opts(args)
           _get
         end
-        menu.choice(:next, "Generate a new passphrase for a service and user.") do |comnmand, args|
+        menu.choice(:next, 'Generate a new passphrase for a service and user.') do |_, args|
           _set_opts(args)
           _next
         end
-        menu.choice(:delete, "Remove a service and user from the Sesame store.") do |command, args|
+        menu.choice(:delete, 'Remove a service and user from the Sesame store.') do |_, args|
           _set_opts(args)
           _delete
         end
-        menu.choice(:exit, "Close Sesame.") do
+        menu.choice(:exit, 'Close Sesame.') do
           done = true
         end
       end
+      _clear_opts
       done
     rescue Fail => e
       _error(e.message)
     end
 
-    def _error(details="An error occurred")
+    def _error(details = 'An error occurred')
       message =
         if @opts[:quiet]
-          _trans("error", details: details)
+          _trans('error', details: details)
         else
-          _trans("jinn.error", details: details)
+          _trans('jinn.error', details: details)
         end
       say(HighLine.color(message, :bold, :red))
     end
 
+    def _warn(details)
+      message =
+        if @opts[:quiet]
+          _trans('warn', details: details)
+        else
+          _trans('jinn.warn', details: details)
+        end
+      say(HighLine.color(message, :bold, :yellow))
+    end
+
     def _new
       words = nil
       if @opts.reconstruct?
-        _info("reconstruct")
-        words = ask("🔑  ") { |q| q.echo = "*" }
+        _info('reconstruct')
+        words = ask('🔑  ') { |q| q.echo = '*' }
       end
       phrase = @sesame.create!(words)
       if words.nil?
-        _info("new")
+        _info('new')
         _show(phrase)
       else
-        _info("reconstructed")
+        _info('reconstructed')
       end
     end
 
     def _open
-      _info("open")
-      words = ask("🔑  ") { |q| q.echo = "*" }
+      _info('open')
+      words = ask('🔑  ') { |q| q.echo = '*' }
       @sesame.open(words)
-      _info("path", path: @sesame.path)
+      _info('path', path: @sesame.path)
     end
 
     def _unlock
-      _info("unlock")
-      key = ask("🔑  ") { |q| q.echo = "*" }
+      _info('unlock')
+      key = ask('🔑  ') { |q| q.echo = '*' }
       @sesame.unlock(key)
-      _info("path", path: @sesame.path)
+      _info('path', path: @sesame.path)
     end
 
     def _forget
-      _info("forgot")
+      _info('forgot')
       @sesame.forget
     end
 
     def _list
-      _info("list")
-      if @opts[:service].nil? || @opts[:service].length == 0
+      _info('list')
+      if @opts[:service].nil? || @opts[:service].length.zero?
         @sesame.index.each do |service, users|
           next if service == 'sesame'
           if users.count > 1
             say("#{service} (#{users.count})")
           else
-            say(service)
+            say("#{service} (#{users.first.first})")
           end
         end
       else
         users = @sesame.index[@opts[:service]]
-        raise Fail, "No such service found, you must be thinking of some other cave" if users.nil? || @opts[:service] == "sesame"
-        users.each do |user, index|
+        raise Fail, 'No such service found, you must be thinking of some other cave' if users.nil? || @opts[:service] == 'sesame'
+        users.sort.each do |user, _|
           say(user)
         end
       end
@@ -220,53 +253,55 @@ module Sesame
 
     def _get
       phrase = @sesame.get(*_question, @opts[:offset])
-      _info("get", @sesame.item)
+      _info('get', @sesame.item)
       _show(phrase)
     end
 
     def _add
       phrase = @sesame.insert(*_question(true), @opts[:offset])
-      _info("add", @sesame.item)
+      _info('add', @sesame.item)
       _show(phrase)
     end
 
     def _next
       phrase = @sesame.update(*_question, @opts[:offset])
       if phrase.nil?
-        _info("next_key")
+        _info('next_key')
+        @was_locked = false
+        _set_opt(:lock, true)
       else
-        _info("next", @sesame.item)
+        _info('next', @sesame.item)
         _show(phrase)
       end
     end
 
     def _delete
       phrase = @sesame.delete(*_question)
-      _info("delete")
+      _info('delete')
       _show(phrase)
     end
 
-    def _lock(silent=false)
+    def _lock
       key = @sesame.lock
-      return if silent
-      _info("lock")
+      return if @was_locked
+      _info('lock')
       _show(key)
     end
 
-    def _info(message, args={})
+    def _info(message, args = {})
       message =
         if @opts[:quiet]
           _trans(message, args)
         else
           _trans("jinn.#{message}", args)
         end
-      return if message.nil? || message.length == 0
+      return if message.nil? || message.length.zero?
       say(HighLine.color(message, :bold, :green))
     end
 
     def _trans(message, args)
       retval = I18n.t(message, args)
-      if retval =~ /^translation missing/
+      if retval.match?(/^translation missing/)
         retval =
           if @opts[:echo]
             I18n.t("#{message}_echo", args)
@@ -285,22 +320,37 @@ module Sesame
       end
     end
 
+    def _set_opt(name, val)
+      return unless val
+      @opts.option(name).ensure_call(val)
+    end
+
     def _set_opts(args)
-      args = args.split(" ").map(&:strip).map(&:downcase)
-      return if args.count == 0
-      @opts[:service] = args.first if args.count < 3
-      @opts[:user] = args.last if args.count == 2
+      args = args.split(' ').map(&:strip).map(&:downcase)
+      return if args.count.zero?
+      _set_opt(:service, args.first) if args.count < 3
+      _set_opt(:user, args.last) if args.count == 2
+    end
+
+    def _clear_opt(name)
+      @opts.option(name).reset
+    end
+
+    def _clear_opts
+      _clear_opt(:service)
+      _clear_opt(:user)
     end
 
-    def _question(user_required=false)
-      service, user = @opts[:service], @opts[:user]
+    def _question(user_required = false)
+      service = @opts[:service]
+      user = @opts[:user]
       if service.nil?
-        _info("service")
-        service = ask("🏷  ")
+        _info('service')
+        service = ask('🏷  ')
       end
       if user.nil? && (user_required || !@sesame.unique?(service))
-        _info("user")
-        user = ask("👤  ")
+        _info('user')
+        user = ask('👤  ')
       end
       [service.downcase, user.nil? ? nil : user.downcase]
     end

data/lib/sesame/lang/en.yml

@@ -23,6 +23,7 @@ en:
   lock_clip: 'Store locked. Unlock code copied to clipboard.'
   service: 'Enter service name:'
   user: 'Enter user name:'
+  warning: 'Warning: %{details}.'
   jinn:
     error: '🧞 - "A thousand apologies! %{details}."'
     open: '🧞 - "Open sesame! Please incant the magic words..."'
@@ -48,3 +49,4 @@ en:
     lock_clip: '🧞 - "I have secured your treasure. The key is in your clipboard."'
     service: '🧞 - "What be the name of the service?"'
     user: '🧞 - "And what be the name of the user?"'
+    warn: '🧞 - "Caution, master! %{details}."'

data/lib/sesame.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sesame/cave'
 require 'sesame/dict'
 require 'sesame/fail'

data/sesame-cli.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: sesame-cli 0.1.0 ruby lib
+# stub: sesame-cli 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "sesame-cli".freeze
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jason Hutchens".freeze, "Jack Casey".freeze]
-  s.date = "2018-04-20"
-  s.description = "Sesame is a simple password manager for the command-line.".freeze
+  s.date = "2018-04-24"
+  s.description = "\u{1F9DE} - \"Sesame is a simple password manager for the command-line!\"".freeze
   s.email = "jasonhutchens@gmail.com".freeze
   s.executables = ["sesame".freeze]
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rubocop.yml",
     "Gemfile",
     "Gemfile.lock",
     "README.md",
@@ -34,14 +35,16 @@ Gem::Specification.new do |s|
     "lib/sesame/jinn.rb",
     "lib/sesame/lang/en.yml",
     "sesame-cli.gemspec",
-    "sesame.gemspec",
+    "spec/cave_spec.rb",
+    "spec/dict_spec.rb",
+    "spec/jinn_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/kranzky/sesame-cli".freeze
   s.licenses = ["UNLICENSE".freeze]
   s.required_ruby_version = Gem::Requirement.new("~> 2.1".freeze)
   s.rubygems_version = "2.7.3".freeze
-  s.summary = "Sesame is a simple password manager for the command-line.".freeze
+  s.summary = "\u{1F9DE} - \"Sesame is a simple password manager for the command-line!\"".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
@@ -60,6 +63,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
       s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.0"])
       s.add_development_dependency(%q<rspec>.freeze, ["~> 3.7"])
+      s.add_development_dependency(%q<rubocop>.freeze, ["~> 0.55"])
       s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.15"])
       s.add_development_dependency(%q<yard>.freeze, ["~> 0.9"])
     else
@@ -76,6 +80,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
       s.add_dependency(%q<rdoc>.freeze, ["~> 6.0"])
       s.add_dependency(%q<rspec>.freeze, ["~> 3.7"])
+      s.add_dependency(%q<rubocop>.freeze, ["~> 0.55"])
       s.add_dependency(%q<simplecov>.freeze, ["~> 0.15"])
       s.add_dependency(%q<yard>.freeze, ["~> 0.9"])
     end
@@ -93,6 +98,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
     s.add_dependency(%q<rdoc>.freeze, ["~> 6.0"])
     s.add_dependency(%q<rspec>.freeze, ["~> 3.7"])
+    s.add_dependency(%q<rubocop>.freeze, ["~> 0.55"])
     s.add_dependency(%q<simplecov>.freeze, ["~> 0.15"])
     s.add_dependency(%q<yard>.freeze, ["~> 0.9"])
   end

data/spec/cave_spec.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Sesame::Cave do
+  let(:cave) { Sesame::Cave.new(Dir.tmpdir, 20) }
+
+  after do
+    cave.close if cave.open?
+    cave.forget if cave.locked?
+    File.delete(cave.path) if cave.exists?
+  end
+
+  describe '#path' do
+    it 'returns the location of the sesame cave' do
+      expect(cave.path).to eq(File.join(Dir.tmpdir, 'sesame.cave'))
+    end
+  end
+
+  describe '#item' do
+    before do
+      phrase = cave.create!
+      cave.insert('foo', 'bar')
+      cave.close
+      cave.open(phrase)
+    end
+
+    it 'returns nothing by default' do
+      expect(cave.item).to be_nil
+    end
+
+    context 'after #get' do
+      before do
+        cave.get('foo')
+      end
+      it 'returns the item' do
+        expect(cave.item[:user]).to eq('bar')
+      end
+    end
+
+    context 'after #insert' do
+      before do
+        cave.insert('xxx', 'yyy')
+      end
+      it 'returns the item' do
+        expect(cave.item[:user]).to eq('yyy')
+      end
+    end
+
+    context 'after #update' do
+      before do
+        cave.update('foo')
+      end
+      it 'returns the item' do
+        expect(cave.item[:user]).to eq('bar')
+      end
+    end
+
+    context 'after #delete' do
+      before do
+        cave.delete('foo')
+      end
+      it 'returns the item' do
+        expect(cave.item[:user]).to eq('bar')
+      end
+    end
+
+    context 'after #lock' do
+      before do
+        cave.insert('xxx', 'yyy')
+        cave.lock
+      end
+      it 'is cleared' do
+        expect(cave.item).to be_nil
+      end
+    end
+  end
+
+  describe '#exists?' do
+    context 'by default' do
+      it 'returns false' do
+        expect(cave.exists?).to be false
+      end
+    end
+
+    context 'after #create! and #close' do
+      before do
+        cave.create!
+        cave.close
+      end
+      it 'returns true' do
+        expect(cave.exists?).to be true
+      end
+    end
+  end
+
+  describe '#locked?' do
+    context 'by default' do
+      it 'returns false' do
+        expect(cave.locked?).to be false
+      end
+    end
+
+    context 'after #create! and #close' do
+      before do
+        cave.create!
+        cave.close
+      end
+      it 'returns false' do
+        expect(cave.locked?).to be false
+      end
+    end
+
+    context 'after #create! and #lock' do
+      before do
+        cave.create!
+        cave.lock
+      end
+      it 'returns true' do
+        expect(cave.locked?).to be true
+      end
+    end
+
+    context 'after #create! and #lock and #forget' do
+      before do
+        cave.create!
+        cave.lock
+        cave.forget
+      end
+      it 'returns false' do
+        expect(cave.locked?).to be false
+      end
+    end
+
+    context 'after #create! and #lock and #unlock' do
+      before do
+        cave.create!
+        code = cave.lock
+        cave.unlock(code)
+      end
+      it 'returns false' do
+        expect(cave.locked?).to be false
+      end
+    end
+  end
+
+  describe '#open?' do
+  end
+
+  describe '#dirty?' do
+  end
+
+  describe '#create!' do
+  end
+
+  describe '#open' do
+  end
+
+  describe '#close' do
+  end
+
+  describe '#lock' do
+  end
+
+  describe '#unlock' do
+  end
+
+  describe '#forget' do
+  end
+
+  describe '#index' do
+  end
+
+  describe '#unique?' do
+  end
+
+  describe '#get' do
+  end
+
+  describe '#insert' do
+  end
+
+  describe '#update' do
+  end
+
+  describe '#delete' do
+  end
+end