lorca 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab5b9ef8040a51c71e968398dc37c1e656cfb50246eb5d576b3565959f5a2f1c
+  data.tar.gz: 86fd64feae9c99878f0d1053f78a1ee2dd399831946f2436b9d4d29f8c590a0a
+SHA512:
+  metadata.gz: ef2adcc3d3fc5c3506e31132aaefe545bd79f4f504be6bab1434d5b15ad73a253fdc3caf37b8697d1a563b520a703a1245467078f5bb70ad673d18ffc78bbc63
+  data.tar.gz: df0ff349f468f3a310842f5ed37546d5c366138b68c43aafecd2c3ed4010fa22a9d76be5f40023a98270f76625d544f97b01ca0906fbe3a4bef50a30520821dd

data/ChangeLog.md

@@ -0,0 +1,38 @@
+# ChangeLog
+
+## [Unreleased]
+
+## [0.3.0]
+
+### Security
+
+- Use `Sysrandom` gem as pseudo-random generator for Ruby versions below 2.5.
+
+### Added
+
+- Lorca expansion system.
+- LorcaCore expansion with base instance, and class, methods.
+- Phrases expansion to generate passphrases. Based on EFF's diceware.
+- CLI expansion to use Lorca from the terminal.
+
+## [0.0.1]
+
+### Security
+
+- Added Manifest for everyone to keep track of gem files. Manually edited.
+
+### Changed
+
+- Extracted gemspec info to added modules.
+
+### Added
+
+- Lorca::LorcaDoc, and Lorca::LorcaManifest modules.
+- License.
+- ChangeLog for users to keep track of relevant gem changes.
+
+## [0.0.0]
+
+### Added
+
+- Lorca gemspec with bare minimum of files, and settings.

data/License.md

@@ -0,0 +1,13 @@
+Copyright (c) 2018, René Maya.
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/Manifest.md

@@ -0,0 +1,45 @@
+ChangeLog.md
+
+License.md
+
+Manifest.md
+
+ReadMe.md
+
+_expand_lib_path.rb
+
+bin/lorca
+
+bin/lorca-alpine
+
+lib/lorca/doc.rb
+
+lib/lorca/manifest.rb
+
+lib/lorca/expansions/cli.rb
+
+lib/lorca/expansions/phrases/eff_large_wordlist.dir
+
+lib/lorca/expansions/phrases/eff_large_wordlist.pag
+
+lib/lorca/expansions/phrases.rb
+
+lib/lorca/version.rb
+
+lib/lorca.rb
+
+test/_config/minitest.rb
+
+test/bin/test_lorca.rb
+
+test/lib/test_lorca.rb
+
+test/lib/lorca/expansions/test_cli.rb
+
+test/lib/lorca/expansions/test_phrases.rb
+
+test/lib/lorca/test_doc.rb
+
+test/lib/lorca/test_manifest.rb
+
+test/lib/lorca/test_version.rb

data/ReadMe.md

@@ -0,0 +1,41 @@
+# Lorca
+
+## Details
+
+Lorca generates passphrases based on the algorithm originally described in
+[EFF Dice-Generated Passphrases](https://www.eff.org/dice).
+It uses [EFF's long word list](https://www.eff.org/files/2016/07/18/eff_large_wordlist.txt).
+
+## System Requirements
+
+- *nix OS.
+- Ruby 2.4+
+
+## Installation
+
+Add to a project's Gemfile:
+
+```ruby
+gem "lorca"
+```
+
+And then run
+
+```bash
+$ bundle
+```
+
+Or to install the command line interface locally:
+
+```bash
+$ gem install lorca
+```
+
+## Quick Start
+
+:TODO: Add usage examples here.
+
+## License
+
+Copyright (c) 2018, René Maya. Licensed ISC. Read attached `License.md` file
+for details.

data/_expand_lib_path.rb

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+
+lib = File.expand_path "./../lib", __FILE__
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib

data/bin/lorca

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby -E UTF-8:UTF-8
+
+require_relative "./../_expand_lib_path"
+require "lorca"
+require "lorca/expansions/cli"
+
+Lorca.add Lorca::CLI
+lorca = Lorca.new
+lorca.run

data/bin/lorca-alpine

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby --enable-frozen-string-literal
+
+require_relative "./../_expand_lib_path"
+require "lorca"
+require "lorca/expansions/cli"
+
+Lorca.add Lorca::CLI
+lorca = Lorca.new
+lorca.run

data/lib/lorca/doc.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+require "lorca/manifest"
+
+class Lorca
+  # Aimed at gemspec, and supported doc generators.
+  module LorcaDoc
+    # One line summary of what Lorca is.
+    def self.summary
+      "Passphrase, and password generator"
+    end
+
+    # Short description of what Lorca does, and how does it do it.
+    def self.description
+      <<~EOH
+      Lorca is a passphrase generator based on diceware made available by the EFF.
+      Passwords, and pins are handle by the system's pseudo-random generator.
+      EOH
+    end
+
+    # Array of options used for building the documentation.
+    def self.build_options
+      [
+        "--line-numbers",
+        "--title", "#{LorcaManifest.official_name}: #{self.summary}",
+        "--main", "ReadMe.md"
+      ]
+    end
+
+    # Array of documented files. These should be listed in Manifest.md.
+    def self.files
+      Lorca::LorcaManifest.files.select { |f|
+        Lorca::LorcaManifest.codebase.any? { |dir| f.start_with? dir }
+      }
+    end
+
+    # Array of extra doc files. These should be listed in Manifest.md.
+    def self.appendices
+      Lorca::LorcaManifest.files.select { |f| f.end_with? ".md" }
+    end
+  end
+end

data/lib/lorca/expansions/cli.rb

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+
+require "optparse"
+require "clipboard"
+require "lorca/expansions/phrases"
+
+class Lorca
+  module CLI # :nodoc:
+
+    # The CLI plugin enables Lorca use through the command line. It autoloads
+    # included plugins.
+    module LorcaPlugin
+      # Run Lorca with +options+ enabled.
+      #   lorca = Lorca.plugin(Lorca::CLI).new
+      #   lorca.run
+      def run options=$argv
+        cli_parse options
+      end
+
+      private
+
+      def cli_parse options
+        Object.new.extend(CLI).parse options
+      end
+    end
+
+    def self.load_dependencies expansion, **_
+      expansion.add Lorca::Phrases
+    end
+
+    def parse argv=$argv, writer:Lorca.new, pad: Clipboard, notice: $stdout
+      cli = OptionParser.new do |parser|
+        write_phrase parser, notice, writer, pad
+        display_help parser, notice
+      end
+
+      cli.parse!(*argv)
+
+      notice.puts cli
+    end
+
+    private
+
+    def write_phrase cli, notice, writer, pad
+      description = "Generate a passphrase with optional number of WORDS"
+      cli.on("-p", "--phrase [WORDS]", Integer, description) { |nw|
+        phrase = nw ? writer.phrase(words: nw) : writer.phrase
+        pad.copy phrase
+        notice.puts "passphrase copied to clipboard"
+        exit_cli
+      }
+    end
+
+    def display_help cli, notice
+      cli.on_tail("-h", "--help", "Show this message") {
+        notice.puts cli
+        exit_cli
+      }
+    end
+
+    def exit_cli status: 0
+      exit status unless ENV["LORCA_ENV"] == "test"
+    end
+  end
+end

data/lib/lorca/expansions/phrases.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+require "sdbm"
+
+class Lorca
+  # Built-in Phrases expansion. Adds all necessary dependencies to enable secure
+  # random phrases. Intended as a passphrase generator.
+  #
+  # It exposes the following instance methods:
+  #
+  # phrase :: A phrase randomly generated suitable as a passphrase.
+  module Phrases
+    # Default minimum number of words a user can request per phrase.
+    MIN_WORDS = 8.freeze
+    # Default maximum number of words a user can request per phrase.
+    MAX_WORDS = 53.freeze
+    # Default number of dice used for rolling a word id. Meant to fit the included
+    # vocabulary.
+    DICE = 5.freeze
+    # The default vocabulary's database path.
+    VOCABULARY = "./lib/lorca/expansions/phrases/eff_large_wordlist"
+
+    # Configure the Lorca::Phrases expansion upon loading.
+    #
+    # The following settings are configurable.
+    #
+    # min_words :: The minimum number of words a user can request per phrase.
+    # max_words :: The maximum number of words a user can request per phrase.
+    # dice_to_toss :: The number of dice to toss to generate a word id. It should
+    #                 only be changed when switching vocabulary.
+    # vocabulary :: The path to the SDBM compatible vocabulary database.
+    def self.configure expansion, min_words: MIN_WORDS, max_words: MAX_WORDS,
+        dice_to_toss: DICE, vocabulary: VOCABULARY
+      config = expansion.settings[:phrases] = {}
+      config[:min_words] = min_words
+      config[:max_words] = max_words
+      config[:dice_to_toss] = dice_to_toss
+      config[:vocabulary] = vocabulary
+    end
+
+    module LorcaPlugin
+      # The phrase written given a number of +words+.
+      def phrase words: settings[:phrases][:min_words]
+        conf = settings[:phrases]
+        words = validate_counter words, range: conf[:min_words]..conf[:max_words]
+        phrase_ids = []
+        words.times { phrase_ids.push(roll_word_id dice: conf[:dice_to_toss]) }
+        phrase_ids.map(&method(:word)).join " "
+      end
+
+      # :nodoc:
+      private
+
+      WordIdError = Class.new StandardError
+
+      def word id, wordlist: settings[:phrases][:vocabulary], manager: SDBM
+        read_only = 0444
+        manager.open(wordlist, read_only) { |db| db.fetch id }
+      rescue => e
+        raise WordIdError, e.message
+      end
+    end
+  end
+end

data/lib/lorca/manifest.rb

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+
+class Lorca
+  # Aimed at basic security auditing tools.
+  module LorcaManifest
+    # Name as used in `require` statements.
+    def self.gem_name
+      official_name.downcase
+    end
+
+    # Name as it's meant to be spelled.
+    def self.official_name
+      "Lorca"
+    end
+
+    # Array of authors' string names
+    def self.authors
+      ["René Maya"].freeze
+    end
+
+    # Array of maintainers' email strings.
+    def self.contact_emails
+      %w[rem@disroot.org].freeze
+    end
+
+    # Main repo url.
+    def self.repo
+      "https://notabug.org/rem/lorca"
+    end
+
+    # License type. Full text in License.md.
+    def self.license
+      "ISC"
+    end
+
+    # Array of official gem files. Manually maintained at Manifest.md.
+    #--
+    # Not frozen, raises warnings building gem.
+    #++
+    def self.files
+      File.readlines("./Manifest.md").map(&:chomp).reject(&:empty?)
+    end
+
+    # Array of directories housing the codebase.
+    def self.codebase
+      src = "lib"
+      [src].freeze if files.any? { |f| f.start_with? "#{src}/" }
+    end
+
+    # Directory housing the test suite.
+    def self.test_suite
+      "test"
+    end
+
+    # Array of test files.
+    def self.tests
+      tests = Dir["test/**/test_*.rb"] - Dir["test/dev/**/*.rb"]
+      tests.freeze
+    end
+
+    # Directory housing binstubs.
+    def self.bindir
+      "bin"
+    end
+
+    # Array of binstubs.
+    def self.binstubs
+      %w[lorca].freeze
+    end
+  end
+end

data/lib/lorca/version.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+
+class Lorca
+  # Major version. Updated for changes that may require users to modify their code.
+  LorcaMajorVersion = 0
+
+  # Minor version. Updated for new feature releases.
+  LorcaMinorVersion = 3
+
+  # Patch version. Updated only for bug fixes from the last feature release.
+  LorcaPatchVersion = 0
+
+  # Full version as a string.
+  LorcaVersion = "#{LorcaMajorVersion}.#{LorcaMinorVersion}.#{LorcaPatchVersion}"
+end

data/lib/lorca.rb

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+require "lorca/version"
+
+begin
+  gem "sysrandom"
+  require "sysrandom/securerandom"
+rescue Gem::LoadError
+  require "securerandom"
+end
+
+# Lorca main class.
+class Lorca
+  # Exception raised by an invalid number of dice
+  LorcaDiceError = Class.new StandardError
+
+  # Exception raised by an invalid range
+  LorcaRangeError = Class.new StandardError
+
+  # Exception raised by an invalid counter
+  LorcaCounterError = Class.new StandardError
+
+  @settings = {}
+
+  # Lorca core methods.
+  module LorcaCore
+    # LorcaCore class methods.
+    module LorcaExtension
+      class << self
+        # Expose warn as it is used for deprecation warnings.
+        # Lorca::LorcaCore::LorcaExtension.warn can be overridden for custom
+        # extension warnings.
+        public :warn
+      end
+
+      # Lorca class settings/configuration hash.
+      attr_reader :settings
+
+      # Adds a Lorca Expansion. An expansion is simply a module which changes
+      # Lorca. Methods defined under the +ExpansionName::LorcaPlugin+ namespace
+      # get included. The ones defined under +ExpansionName::LorcaExtension+,
+      # extended.
+      #
+      # Expansions can define +ExpansionName.load_dependencies+ to load, and
+      # configure their dependencies. They can also define +ExpansionName.configure+
+      # so users can modify its settings.
+      #--
+      # don't load from load_path; security over convenience
+      # rename add
+      #++
+      def add expansion, **stns, &block
+        expansion.load_dependencies(self, **stns, &block) if expansion.respond_to?(:load_dependencies)
+        include expansion::LorcaPlugin if defined? expansion::LorcaPlugin
+        extend expansion::LorcaExtension if defined? expansion::LorcaExtension
+        expansion.configure(self, **stns, &block) if expansion.respond_to?(:configure)
+        self
+      end
+    end
+
+    # LorcaCore instance methods.
+    module LorcaPlugin
+      # Lorca instance settings hash. Frozen duplicate of class settings meant
+      # for reading expansion configurations.
+      def settings
+        self.class.settings.dup.freeze
+      end
+
+      # Roll a word id using given number of +dice+.
+      def roll_word_id(dice:)
+        dice = validate_counter dice, range: dice..dice
+        id = ""
+        dice.times { id += roll_dice.to_s }
+        id
+      rescue Lorca::LorcaCounterError => e
+        raise Lorca::LorcaDiceError, e.message
+      end
+
+      # Roll a six-sided dice.
+      def roll_dice
+        (SecureRandom.random_number(5) + 1)
+      end
+
+      # Validate a given counter +number+ is within the given +range+.
+      def validate_counter(number, range:)
+        num = validate_positive_integer number
+        return num if num == range.min && num == range.max
+
+        range = validate_range range
+        range.cover?(num) ? num : fail(LorcaCounterError, "Counter out of range")
+      end
+
+      # Validate the +range+ given is end-inclusive, and only positive numbers.
+      def validate_range range
+        validate_positive_integer range.min
+        validate_positive_integer range.max
+        range
+      rescue Lorca::LorcaCounterError
+        raise LorcaRangeError, "Should be an end-inclusive range of positive integers"
+      end
+
+      # Validate +counter+ is a number greater than zero.
+      def validate_positive_integer counter
+        unless counter.is_a?(Integer) && counter > 0
+          fail LorcaCounterError, "Should be a positive integer"
+        end
+        counter
+      end
+    end
+  end
+
+  extend LorcaCore::LorcaExtension
+  add LorcaCore
+end

data/test/_config/minitest.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/proveit"
+require "minitest/unordered"
+require_relative "./../../_expand_lib_path"
+
+class Minitest::Test
+  make_my_diffs_pretty!
+  prove_it!
+end
+
+module Minitest::Assertions
+  def assert_frozen obj
+    assert obj.frozen?, "Expected #{obj.inspect} to be frozen"
+  end
+end

data/test/bin/test_lorca.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+
+require "_config/minitest"
+require "rbconfig"
+
+class TestLorcaBin < Minitest::Test
+  def test_binstubs_return_usage_by_default
+    skip "slow CLI Integration" unless ENV["LORCA_ALL_TESTS"]
+
+    host = RbConfig::CONFIG["host_vendor"]
+    lorca = "lorca"
+    lorca += %r"alpine".match?(host) ? "-#{host}" : ""
+
+    out, _ = capture_subprocess_io { system lorca }
+    assert_match %r"usage:"i, out
+  end
+
+  def test_binstubs_permissions
+    lorca = "bin/lorca"
+
+    assert File.executable_real? lorca
+    assert File.executable_real? "#{lorca}-alpine"
+  end
+end

data/test/lib/lorca/expansions/test_cli.rb

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+require_relative "./../../../_config/minitest"
+require "lorca/expansions/cli"
+
+class TestLorcaCLIExpansion < Minitest::Test
+
+  # test dependencies, useful for testing Lorca::CLI but should be replaceable
+  require "lorca"
+  require "clipboard" # Lorca can't paste, nor clear, clipboard contents
+
+  def setup
+    @argv = -> options { Array[StringIO.new(options).read.split] }
+    @cli = Object.new.extend Lorca::CLI
+  end
+
+  def test_display_help_when_no_options_given
+    assert_output(%r"\Ausage"i) { @cli.parse @argv.("") }
+  end
+
+  def test_h__help_shows_usage_info
+    assert_output(%r"\Ausage"i) { @cli.parse @argv.("-h") }
+    assert_output(%r"\Ausage"i) { @cli.parse @argv.("--help") }
+  end
+
+  def test_p__phrase_copies_passphrase_to_clipboard
+    writer = Lorca.add(Lorca::Phrases).new
+    message = %r"\Apassphrase copied to clipboard\n"i # no `\z` due to `exit_cli`
+    copied = "ah"
+
+    writer.stub :phrase, copied do
+      assert_output(message) { @cli.parse @argv.("--phrase"), writer: writer }
+      assert_output { @cli.parse @argv.("-p"), writer: writer }
+    end
+
+    assert_equal copied, Clipboard.paste
+    Clipboard.clear
+  end
+
+  def test_phrase_is_composed_of_as_many_words_as_the_given_number
+    writer = Lorca.add(Lorca::Phrases).new
+    copied = "ah"
+
+    writer.stub :phrase, copied do
+      _ = capture_io { @cli.parse @argv.("--phrase 9"), writer: writer }
+      assert_equal copied, Clipboard.paste
+    end
+    Clipboard.clear
+  end
+end
+
+class TestCLILorcaPlugin < Minitest::Test
+  def test_lorca_cli_plugin
+    argv = -> options { Array[StringIO.new(options).read.split] }
+    lorca = Lorca.add(Lorca::CLI).new
+
+    assert_output(%r"\Ausage"i) { lorca.run argv.("") }
+  end
+end

data/test/lib/lorca/expansions/test_phrases.rb

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+require_relative "./../../../_config/minitest"
+require "lorca"
+require "lorca/expansions/phrases"
+
+# Use stubs for built-in expansions. External ones should instanciate Lorca.
+class TestLorcaPhrasesExpansion < Minitest::Test
+  def setup
+    Lorca.add Lorca::Phrases
+    @lorca = Lorca.new
+  end
+
+  def test_returns_a_phrase_with_a_pre_set_length
+    @lorca.stub(:roll_word_id, "11111") do
+      assert_match %r"\A(abacus *){8}\z", @lorca.phrase
+    end
+  end
+
+  def test_writes_a_phrase_which_words_matches_the_given_number
+    num = 10
+
+    @lorca.stub(:roll_word_id, "11111") do
+      assert_match %r/([a-z]+ *){#{num}}/, @lorca.phrase(words: num)
+    end
+  end
+
+  def test_fails_to_return_a_phrase_given_less_words_than_default
+    assert_raises(Lorca::LorcaCounterError) { @lorca.phrase words: 7 }
+  end
+
+  def test_fails_to_return_a_phrase_given_an_invalid_amount_of_words
+    assert_raises(Lorca::LorcaCounterError) { @lorca.phrase words: Object.new }
+  end
+
+  def test_configures_min_words
+    Lorca.add Lorca::Phrases, min_words: 9
+
+    assert_equal 9, Lorca.settings[:phrases][:min_words]
+
+    @lorca.stub(:roll_word_id, "11111") do
+      assert_match %r"\A(abacus *){9}\z", @lorca.phrase
+    end
+  end
+
+  def test_configures_max_words
+    Lorca.add Lorca::Phrases, max_words: 12
+
+    assert_equal 12, Lorca.settings[:phrases][:max_words]
+    assert_raises { @lorca.phrase words: 13 }
+  end
+
+  def test_configures_dice_to_toss_per_word_id
+    Lorca.add Lorca::Phrases, dice_to_toss: 3
+
+    assert_equal 3, Lorca.settings[:phrases][:dice_to_toss]
+    assert_raises { @lorca.phrase }
+  end
+
+  def test_configures_vocabulary
+    path = "path/to/non/existent/vocab"
+    Lorca.add Lorca::Phrases, vocabulary: path
+    assert_equal path, Lorca.settings[:phrases][:vocabulary]
+    assert_raises { @lorca.phrase }
+  end
+end

data/test/lib/lorca/test_doc.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+
+require "_config/minitest"
+require "lorca/doc"
+
+# Tests w/ assert_respond_to show we care about the method existing not what's
+# returned, nor it's type. The type is implicitly check by building a gem w/o
+# warnings. There's a test for that.
+class TestLorcaDoc < Minitest::Test
+  def test_has_summary
+    assert_respond_to Lorca::LorcaDoc, :summary
+  end
+
+  def test_has_description
+    assert_respond_to Lorca::LorcaDoc, :description
+  end
+
+  def test_has_build_options
+    assert_respond_to Lorca::LorcaDoc, :build_options
+  end
+
+  def test_documented_files_are_listed_in_the_manifest
+    manifest = Lorca::LorcaManifest.files
+    Lorca::LorcaDoc.files.each { |f| assert_includes manifest, f }
+  end
+
+  def test_appendices_are_among_files_listed_in_the_manifest
+    manifest = Lorca::LorcaManifest.files
+    Lorca::LorcaDoc.appendices.each { |a| assert_includes manifest, a }
+  end
+end

data/test/lib/lorca/test_manifest.rb

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+require_relative "./../../_config/minitest"
+require "lorca/manifest"
+
+class TestLorcaManifest < Minitest::Test
+  def test_has_gem_name
+    assert_equal "lorca", Lorca::LorcaManifest.gem_name
+  end
+
+  def test_has_official_name
+    assert_equal "Lorca", Lorca::LorcaManifest.official_name
+  end
+
+  def test_has_authors
+    expected_authors = ["René Maya"]
+    authors = Lorca::LorcaManifest.authors
+
+    assert_equal expected_authors, authors
+    assert_frozen authors
+  end
+
+  def test_has_contact_emails
+    expected_emails = %w[rem@disroot.org]
+    emails = Lorca::LorcaManifest.contact_emails
+    assert_equal expected_emails, emails
+    assert_frozen emails
+  end
+
+  def test_has_repo
+    assert_equal "https://notabug.org/rem/lorca", Lorca::LorcaManifest.repo
+  end
+
+  def test_has_license
+    assert_equal "ISC", Lorca::LorcaManifest.license
+  end
+
+  def test_has_files
+    # test/**/dev/**/*.* files are excluded because they are development helpers
+    expected_files =
+      %w[ChangeLog.md License.md Manifest.md ReadMe.md _expand_lib_path.rb] +
+      Dir["bin/*"] +
+      Dir["{lib,test}/**/*.{rb,txt,dir,pag}"] -
+      Dir["test/**/dev/**/*.{rb,txt}"]
+
+    # assert_frozen missing. Apparently Gem::Specification mutates it.
+    # must be unordered because CI
+    assert_equal_unordered expected_files, Lorca::LorcaManifest.files
+  end
+
+  def test_codebase_returns_required_paths_basenames
+    lib = "lib"
+    codebase = Lorca::LorcaManifest.codebase
+
+    assert Lorca::LorcaManifest.files.any? { |f| %r[\A#{lib}/(.*)].match? f }
+    assert_equal [lib], codebase
+    assert_frozen codebase
+  end
+
+  def test__test_suite_returns_test_dir_basename
+    suite = "test"
+    assert_equal suite, Lorca::LorcaManifest.test_suite
+    assert Lorca::LorcaManifest.files.any? { |f| %r[\A#{suite}/(.*)].match? f }
+  end
+
+  def test__tests_are_included_in_the_manifest
+    tests = Lorca::LorcaManifest.tests
+    files = Lorca::LorcaManifest.files
+
+    tests.each { |t| assert_includes files, t }
+    assert_frozen tests
+  end
+
+  def test_has_bindir
+    assert_equal "bin", Lorca::LorcaManifest.bindir
+  end
+
+  def test_binstubs_are_among_files_in_the_manifest
+    binstubs = Lorca::LorcaManifest.binstubs
+    files = Lorca::LorcaManifest.files
+    bindir = Lorca::LorcaManifest.bindir
+
+    binstubs.each { |b| assert_includes files, "#{bindir}/#{b}" }
+    assert_frozen binstubs
+  end
+end

data/test/lib/lorca/test_version.rb

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+
+require "_config/minitest"
+require "lorca/version"
+
+class TestLorcaVersion < Minitest::Test
+  def test_lorca_has_a_version
+    assert_match %r{\d+.\d+.\d+}, Lorca::LorcaVersion
+  end
+end

data/test/lib/test_lorca.rb

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+require_relative "./../_config/minitest"
+require "lorca"
+
+module FakeExpansion
+  module LorcaPlugin
+    def fake
+    end
+  end
+
+  module LorcaExtension
+    def warn msg="extension deprecation"
+      super msg
+    end
+  end
+end
+
+module NoPluginExpansion
+  LorcaExtension = Module.new
+end
+
+module NoExtensionExpansion
+  LorcaPlugin = Module.new
+end
+
+module LoadsDependenciesExpansion
+  def self.load_dependencies mod, **_
+    mod.send(:include, Module.new {
+        def whatever
+          true
+        end
+      }
+    )
+  end
+end
+
+module ConfigurableExpansion
+  def self.configure mod, **stns#, &block
+    mod.settings[:something] = stns[:something]
+  end
+end
+
+class TestLorcaCoreExtension < Minitest::Test
+  def test_lorca_can_add_expansions
+    Lorca.add FakeExpansion
+    lorca = Lorca.new
+
+    assert_respond_to lorca, :fake
+  end
+
+  def test_extensions_can_override_warn_for_custom_warnings
+    Lorca.add FakeExpansion
+    _, warning = capture_io { Lorca.warn }
+
+    assert_match %r/extension deprecation/, warning
+  end
+
+  def test_add_expansion_with_no_plugin
+    assert Lorca.add(NoPluginExpansion)
+  end
+
+  def test_add_expansion_with_no_extension
+    assert Lorca.add(NoExtensionExpansion)
+  end
+
+  def test_add_expansions_in_succession
+    assert Lorca.add(Module.new).add(Module.new)
+  end
+
+  def test_expansion_can_load_dependencies_when_needed
+    Lorca.add LoadsDependenciesExpansion
+    assert Lorca.new.whatever
+  end
+
+  def test_can_configure_expansion_when_added
+    Lorca.add ConfigurableExpansion, something: "configured"
+    assert_equal "configured", Lorca.settings[:something]
+  end
+end
+
+class TestLorcaCorePlugin < Minitest::Test
+  def setup
+    @lorca = Lorca.new
+  end
+
+  def test_has_immutable_settings
+    assert_frozen @lorca.settings
+  end
+
+  def test_rolls_dice
+    assert_includes 1..6, @lorca.roll_dice
+  end
+
+  def test_rolls_a_word_id_given_n_dice
+    n_dice = 5
+    assert_match %r/[1-6]{#{n_dice}}/, @lorca.roll_word_id(dice: n_dice)
+  end
+
+  def test_fails_to_roll_word_id_given_invalid_number_of_dice
+    [0, -1, nil, Object.new].map do |invalid_dice|
+      e = assert_raises(Lorca::LorcaDiceError) {
+        @lorca.roll_word_id dice: invalid_dice
+      }
+      assert_match %r"should be a positive integer"i, e.message
+    end
+  end
+
+  def test_validates_counter_is_within_range
+    num = 8
+    assert_equal num, @lorca.validate_counter(num, range: 1..10)
+  end
+
+  def test_fails_to_validate_counter_out_of_range
+    err_min = assert_raises(Lorca::LorcaCounterError) do
+      @lorca.validate_counter 3, range: 4..7
+    end
+
+    err_max = assert_raises(Lorca::LorcaCounterError) do
+      @lorca.validate_counter 8, range: 4..7
+    end
+
+    message = %r"\Acounter out of range\z"i
+    assert_match message, err_min.message
+    assert_match message, err_max.message
+  end
+
+  def test_validates_a_range
+    range = 3..6
+    assert_equal range, @lorca.validate_range(range)
+  end
+
+  def test_fails_to_validate_an_invalid_range
+    [3..2, 4..0, -1..4, "a".."z"].map do |invalid_range|
+      e = assert_raises(Lorca::LorcaRangeError) {
+        @lorca.validate_range invalid_range
+      }
+      assert_match %r"\Ashould be an end-inclusive range of positive integers\z"i,
+        e.message
+    end
+  end
+
+  def test_validates_positive_integer
+    num = 8
+    assert_equal num, @lorca.validate_positive_integer(num)
+  end
+
+  def test_fails_to_validate_positive_integer_given_invalid_input
+    [-1, 0, 2.1, Object.new, nil].map do |invalid_counter|
+      e = assert_raises(Lorca::LorcaCounterError) {
+        @lorca.validate_positive_integer invalid_counter
+      }
+
+      assert_match %r"\Ashould be a positive integer\z"i, e.message
+    end
+  end
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: lorca
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- René Maya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: hanna-nouveau
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: minitest-unordered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: |
+  Lorca is a passphrase generator based on diceware made available by the EFF.
+  Passwords, and pins are handle by the system's pseudo-random generator.
+email:
+- rem@disroot.org
+executables:
+- lorca
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- License.md
+- Manifest.md
+- ReadMe.md
+files:
+- ChangeLog.md
+- License.md
+- Manifest.md
+- ReadMe.md
+- _expand_lib_path.rb
+- bin/lorca
+- bin/lorca-alpine
+- lib/lorca.rb
+- lib/lorca/doc.rb
+- lib/lorca/expansions/cli.rb
+- lib/lorca/expansions/phrases.rb
+- lib/lorca/expansions/phrases/eff_large_wordlist.dir
+- lib/lorca/expansions/phrases/eff_large_wordlist.pag
+- lib/lorca/manifest.rb
+- lib/lorca/version.rb
+- test/_config/minitest.rb
+- test/bin/test_lorca.rb
+- test/lib/lorca/expansions/test_cli.rb
+- test/lib/lorca/expansions/test_phrases.rb
+- test/lib/lorca/test_doc.rb
+- test/lib/lorca/test_manifest.rb
+- test/lib/lorca/test_version.rb
+- test/lib/test_lorca.rb
+homepage: https://notabug.org/rem/lorca
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--line-numbers"
+- "--title"
+- 'Lorca: Passphrase, and password generator'
+- "--main"
+- ReadMe.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+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: Passphrase, and password generator
+test_files:
+- test/bin/test_lorca.rb
+- test/lib/lorca/expansions/test_cli.rb
+- test/lib/lorca/expansions/test_phrases.rb
+- test/lib/lorca/test_doc.rb
+- test/lib/lorca/test_manifest.rb
+- test/lib/lorca/test_version.rb
+- test/lib/test_lorca.rb