mummy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a890241f44e9643fb33f575ad428c2e05f0cdd6a
-  data.tar.gz: 367d61ed4e321e199abce4c61bbfa63b3d7dc02d
+  metadata.gz: db015bc733b6b49de96ef31c752283749544c3b5
+  data.tar.gz: 9d2001497f2fe74989004927d893797bf4583b94
 SHA512:
-  metadata.gz: f55dd827b019bc2c1e60a61b646d42fe461f3994de62781a230a35e71da6ce78c9093984dbade9d72248d461845482318584264dda5f2196dfe392378e14916f
-  data.tar.gz: 222ed2ce3fb044d68a438dfd5379850a77d8290aad5ecb806f59e624e9ff0807c45b26ef06e9776145a10317b7973600391f4fd5172ab174755292de8cdf69f0
+  metadata.gz: 1f91d1cf61000ad55269cea70d8df8fe09dbead2ee31c1a565ecd940892d4e04bb6968a8e68745b97d344f1c9c2ea22078f98899a6a17c7516526dda1b32da07
+  data.tar.gz: 14817da1a5a6aeaf290ae8a52da8a2dee6d1eedf9cbbf55b945fb0aa4dd6a4e57daa7de2f1c0e656b0eaf9fbb8f18be866e622600b9ad9d891c16fcf348b9b48

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 2.2.0
+  - 2.0.0
 before_install: gem install bundler -v 1.10.2

data/README.md

@@ -1,10 +1,12 @@
 # Mummy
 
+[![Gem Version](https://badge.fury.io/rb/mummy.svg)](http://badge.fury.io/rb/mummy) [![Build Status](https://travis-ci.org/timrogers/mummy.svg)](https://travis-ci.org/timrogers/mummy)
+
 Mummy makes it easy to test yourself for tests and exams. *Just like your mum did back when you were younger.*
 
 ## Usage
 
-Install the gem:
+Install the gem *(Ruby 2.0.0 and later only)*:
 
 ```bash
 $ gem install mummy
@@ -14,14 +16,14 @@ Then, run `mummy` with a path to a file to run your test from:
 
 ```bash
 $ mummy GV101/Democracy.txt
-$ mummy GV100/Plato.md
+$ mummy GV100/Plato.md --markdown-heading-level 1
 ```
 
-You can write your tests in __Markdown__ (.md) and __plain-text__ (.txt) files.
+You can write your tests in __Markdown__ (.md) and __plain-text__ (.txt) files. __Mummy__ will detect the right parser to use based on the file type, but you can specify this yourself with a `--parser` command line argument (e.g. `--parser markdown` or `--parser text`).
 
 If you're using a text file, just separate the terms you want to be tested on with line breaks.
 
-If you're using Markdown, prefix the terms to be tested on with `##` (i.e. write them as second-level headings).
+If you're using Markdown, prefix the terms to be tested on with `##` (i.e. write them as second-level headings). You can change the heading level you want to look for from the default of H2 (`##`) by specifying a `--markdown-heading-level` command line option (e.g. `--markdown-heading-level 1` will look for lines starting with one "#").
 
 __Mummy__ will read the terms back to you in random order. Hit enter to move onto the next one, or enter an asterisk (`*`) before hitting enter if you want to run by that term again at the end.
 
@@ -35,7 +37,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/timrogers/mummy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/exe/mummy

@@ -6,4 +6,5 @@ unless path = ARGV[0]
   raise "You must provide the path to a file as an argument to `mummy`."
 end
 
-Mummy::Test.from_file(path).run
+options = Mummy::Options.parse
+Mummy::Test.from_file(path, options).run

data/lib/mummy.rb

@@ -1,6 +1,9 @@
+require "slop"
+
 require "mummy/version"
 require "mummy/test"
 require "mummy/parsers/base_parser"
 require "mummy/parsers/markdown_parser"
 require "mummy/parsers/txt_parser"
 require "mummy/constants"
+require "mummy/options"

data/lib/mummy/constants.rb

@@ -11,5 +11,17 @@ module Mummy
         TXT => Mummy::Parsers::TxtParser
       }.freeze
     end
+
+    module Parsers
+      PERMITTED = [Mummy::Parsers::MarkdownParser, Mummy::Parsers::TxtParser].freeze
+
+      MARKDOWN = "markdown".freeze
+      TEXT = "text".freeze
+
+      NAMES = {
+        MARKDOWN => Mummy::Parsers::MarkdownParser,
+        TEXT => Mummy::Parsers::TxtParser
+      }.freeze
+    end
   end
 end

data/lib/mummy/options.rb

@@ -0,0 +1,33 @@
+require "slop"
+require "mummy/constants"
+
+module Mummy
+  class Options
+    def self.options
+      @options ||= Slop::Options.new.tap do |options|
+        options.string "-p", "--parser",
+                       "Parser to use instead of detecting automatically" \
+                       "(#{Constants::Parsers::NAMES.keys.join(', ')})"
+
+        options.on "-h", "--help" do
+          puts self
+          exit
+        end
+
+        Constants::Parsers::PERMITTED.each do |klass|
+          klass.provide_options(options)
+        end
+      end
+    end
+
+    def self.parse(input = ARGV)
+      parser.parse(input).to_hash
+    end
+
+    private
+
+    def self.parser
+      @parser ||= Slop::Parser.new(options)
+    end
+  end
+end

data/lib/mummy/parsers/base_parser.rb

@@ -1,17 +1,24 @@
 module Mummy
   module Parsers
     class BaseParser
-      def initialize(input)
+      def initialize(input, options = {})
         @input = input
+        @options = options
       end
 
       def items
         raise NotImplementedError, "#items must be imlemented by a BaseParser subclass"
       end
 
+      # Override this in a subclass if you want the parser to support command line options
+      # - see MarkdownParser for an example, or the `slop` readme
+      # (https://github.com/leejarvis/slop)
+      def self.provide_options(slop_options)
+      end
+
       private
 
-      attr_reader :input
+      attr_reader :input, :options
     end
   end
 end

data/lib/mummy/parsers/markdown_parser.rb

@@ -3,9 +3,23 @@ module Mummy
     class MarkdownParser < BaseParser
       def items
         @items ||= input.lines.select do |line|
-          line[0..1] == "##"
+          line.start_with?("#{heading_marker} ")
         end.map { |line| line[2..-1].strip }
       end
+
+      def self.provide_options(slop_options)
+        slop_options.integer "--markdown-heading-level",
+                             "Heading level to use to find items (e.g. 2 means '##')",
+                             default: 2
+      end
+
+      private
+
+      # This weird symbol/string combo below is annoying. I've made a PR to `slop` to
+      # fix it, see https://github.com/leejarvis/slop/pull/169
+      def heading_marker
+        "#" * options[:"markdown-heading-level"]
+      end
     end
   end
 end

data/lib/mummy/parsers/txt_parser.rb

@@ -2,7 +2,7 @@ module Mummy
   module Parsers
     class TxtParser < BaseParser
       def items
-        @items ||= input.lines.map(&:strip)
+        @items ||= input.lines.compact.map(&:strip)
       end
     end
   end

data/lib/mummy/test.rb

@@ -1,11 +1,17 @@
 module Mummy
   class Test
-    def self.from_file(path)
+    def self.from_file(path, options = {})
       extension = File.extname(path)
       input = File.read(path)
 
-      if parser = Mummy::Constants::Extensions::PARSERS[extension.downcase]
-        items = parser.new(input).items
+      if options[:parser]
+        parser = Mummy::Constants::Parsers::NAMES[options[:parser].downcase]
+        raise "The specified parser, #{options[:parser]}, does not exist" unless parser
+
+        items = parser.new(input, options).items
+        new(items)
+      elsif parser = Mummy::Constants::Extensions::PARSERS[extension.downcase]
+        items = parser.new(input, options).items
         new(items)
       else
         raise "The file isn't of a supported extension - the following are supported: " \
@@ -19,6 +25,8 @@ module Mummy
     end
 
     def run
+      raise "No items were found - is your file formatted correctly?" unless items.any?
+
       items.shuffle.each_with_index do |item, index|
         puts "#{index + 1}/#{items.count}. #{item}"
         @starred.push(item) if $stdin.gets.chomp.include?("*")

data/lib/mummy/version.rb

@@ -1,3 +1,3 @@
 module Mummy
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/mummy.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "slop", "~> 4.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mummy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tim Rogers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
 description: 
 email:
 - tim@gocardless.com
@@ -73,6 +87,7 @@ files:
 - exe/mummy
 - lib/mummy.rb
 - lib/mummy/constants.rb
+- lib/mummy/options.rb
 - lib/mummy/parsers/base_parser.rb
 - lib/mummy/parsers/markdown_parser.rb
 - lib/mummy/parsers/txt_parser.rb