ibsenphrase 0.1.1

data/ibsenphrase.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ibsenphrase/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ibsenphrase"
+  spec.version       = Ibsenphrase::VERSION
+  spec.authors       = ["Sigve Indregard"]
+  spec.email         = ["sigve@indregard.no"]
+
+  spec.summary       = "Generates diceware passphrases with words from Ibsen."
+  spec.description   = "Passphrases with random words picked from a large wordlist are safer and easier to remember than random characters. This gem lets you create such passphrases with words from harvested from the writings of playwright Henrik Ibsen."
+  spec.homepage      = "https://github.com/sigvei/ibsenphrase"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['yard_run'] = 'yri'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 9.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+
+  spec.add_dependency 'unicode', '~> 0.4'
+end

data/lib/ibsenphrase/generator.rb

@@ -0,0 +1,55 @@
+require 'unicode'
+
+module Ibsenphrase
+  # A generator for passphrases
+  class Generator
+    # Generates a passphrase of words
+    # @num_words [Integer] Number of words in passphrase
+    # @opts (see #initialize)
+    def self.passphrase(num_words=7, opts={})
+      gen = Generator.new(opts)
+      gen.passphrase(num_words)
+    end
+
+    # Initialize a generator instance
+    #
+    # @option opts [String] :wordlist 'words' The wordlist (in data/wordslists)
+    # @option opts [Symbol] :separation ':space' The type of separation, either
+    #   :space (for lists like this: 'word word word') or :capitalize (
+    #   WordWordWord).
+    def initialize(opts={})
+      default_options = { wordlist: 'words', separation: :space }
+      @options = default_options.merge(opts)
+
+      unless [:space, :capitalize].include?(@options[:separation])
+        raise ArgumentError, 'option :separation must be :space or :capitalize'
+      end
+
+      @wordlist = Wordlist.new(@options[:wordlist])
+    end
+
+    # Generate a passphrase, that is, a sequence of words.
+    # Please note that the method generates a new passphrase each time it
+    # is called.
+    #
+    # Whether to use space-separated or capitalized passphrases is determined
+    # by options passed.
+    #
+    # @param num_words [Integer] Number of words in passphrase
+    # @return [String] The passphrase
+    def passphrase(num_words=7)
+      unless num_words.is_a?(Numeric) && num_words.to_i > 0
+        raise ArgumentError, 'num_words must be integer > 0'
+      end
+
+      words = Array.new(num_words).map{ @wordlist.draw_word }
+
+      if @options[:separation] == :space
+        words.join(' ')
+      else
+        words.map{|w| Unicode::capitalize(w)}.join
+      end
+    end
+
+  end
+end

data/lib/ibsenphrase/random.rb

@@ -0,0 +1,12 @@
+module Ibsenphrase
+  # This encapsulates the pseudo-random number generator (PRNG), essentially
+  # turning it into a singleton class. This is done to avoid instantiating a
+  # new PRNG every time we need it, as that would make us dependent on the
+  # randomness of the operating system's seed, instead of the random number
+  # generator code in Ruby.
+  class Random
+    def self.prng
+      @@rng ||= Random.new
+    end
+  end
+end

data/lib/ibsenphrase/version.rb

@@ -0,0 +1,3 @@
+module Ibsenphrase
+  VERSION = "0.1.1"
+end

data/lib/ibsenphrase/wordlist.rb

@@ -0,0 +1,38 @@
+module Ibsenphrase
+  class Wordlist
+    # A new wordlist object. It loads the file from disk on instantiation.
+    # @param filename [String] The filename without path. The file is looked
+    #   for in data/wordlists.
+    def initialize(filename)
+      @words = []
+      load_words(filename)
+    end
+
+    # Picks a random word from the wordlist
+    #
+    # @return [String] A word
+    def draw_word
+      @words.sample(random: Ibsenphrase::Random.prng)
+    end
+
+    # @return [Array<String>] All the words in the wordlist
+    def words
+      @words
+    end
+
+    # @return [Integer] Number of words in wordlist
+    def num_words
+      @words.size
+    end
+
+    private
+
+    def load_words(filename)
+      path = File.join(Ibsenphrase.root, 'data', 'wordlists', filename)
+
+      File.foreach path do |l|
+        @words << l.strip
+      end
+    end
+  end
+end

data/lib/ibsenphrase.rb

@@ -0,0 +1,12 @@
+require "ibsenphrase/version"
+require "ibsenphrase/generator"
+require "ibsenphrase/wordlist"
+require "ibsenphrase/random"
+
+module Ibsenphrase
+  class << self
+    def root
+      @@ROOT ||= File.expand_path(File.join(File.dirname(__FILE__), '..'))
+    end
+  end
+end

data/util/make-words.rb

@@ -0,0 +1,19 @@
+require 'unicode'
+
+words = []
+line = 0
+File.foreach(ARGV[0]) do |l|
+  line = line + 1
+  orig = l
+  l = Unicode::downcase l
+  l.gsub!(/[^a-zæøå]/, ' ')
+  l.strip!
+  l.split.each do |w|
+    if w == "ngden"
+      STDERR.puts "#{line}: ngden: #{orig}"
+    end
+    words << w if w.length > 1
+  end
+end
+
+puts words.uniq.sort.join "\n"

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: ibsenphrase
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sigve Indregard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: unicode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Passphrases with random words picked from a large wordlist are safer
+  and easier to remember than random characters. This gem lets you create such passphrases
+  with words from harvested from the writings of playwright Henrik Ibsen.
+email:
+- sigve@indregard.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/wordlists/originaler.txt
+- data/wordlists/test
+- data/wordlists/words
+- ibsenphrase.gemspec
+- lib/ibsenphrase.rb
+- lib/ibsenphrase/generator.rb
+- lib/ibsenphrase/random.rb
+- lib/ibsenphrase/version.rb
+- lib/ibsenphrase/wordlist.rb
+- util/make-words.rb
+homepage: https://github.com/sigvei/ibsenphrase
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  yard_run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generates diceware passphrases with words from Ibsen.
+test_files: []