recipe_box 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7265f5e6119d319eb7e9b71e6cdaaf3a90f6de8e
+  data.tar.gz: af878526adba49fac7f7dbe5794de36d35a56234
+SHA512:
+  metadata.gz: 0577a74c42baf9e03089e3af681291dccc2827faf864038ce198d72801d4075e541853d6d9d1e4c08ac758d521e24463d22680faa82e30ef268e6e913cf734b0
+  data.tar.gz: 68106a9ea8e845259221a290970557617279ac9fdbccb695b11b1a2f0d5002b828c634ed02880db27ae2f3216e6059f3da7d512959dc0191cbaeb0df757f19ce

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in recipe_box.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Josh Klina
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# RecipeBox
+
+This is basically a couple of file generators thrown together to enforce a specific format for storing recipes. 
+
+## Installation
+
+    $ gem install recipe_box
+
+## Usage
+
+You begin by creating a directory to store your reipes, or just type:
+
+`recipe_box new my_recipe_box`
+
+Once you have a dedicated directory for your recipes jump inside of it and try creating a new recipe:
+
+`cd my_recipe_box`
+`recipe_box insert roast_chicken`
+
+This will create a new directory with a basic markdown template you can use. At this point, use your favorite editor to edit the file. Since each recipe has its own directory you can add images or even multiple files, or keep it as simple as a single markdown file.
+
+If you want to remove a recipe you can manually delete the directory or type:
+
+`recipe_box remove roast_chicken`
+
+This will delete the directory and the files inside the directory of the given recipe.
+
+Since all the content is nothing but directories and markdown, you can use Git to keep track of all your changes and even save your recipes to a remote repository! A nice side effect is that you'll be able to track all the changes and modifications you make to your recipes. 
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/recipe_box/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['features/**/*_spec.rb']
+end

data/bin/recipe_box

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/recipe_box'
+
+RecipeBox::CLI.start(ARGV)

data/features/helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/mock'
+require 'mocha/mini_test'
+require_relative '../lib/recipe_box'

data/features/recipe_box_spec.rb

@@ -0,0 +1,51 @@
+require_relative 'helper'
+
+describe "creating a recipe box" do
+  it "creates a proper directory structure" do
+    name = "cool_recipes"
+    out = capture_io{ RecipeBox::CLI.start %w{ new cool_recipes } }.join ''
+    assert File.directory?(name)
+  end
+end
+
+describe "creating a recipe" do
+  before do
+    @recipe_name = "flan"
+    @out = capture_io{ RecipeBox::CLI.start %w{ insert flan } }.join ''
+  end
+
+  it "creates a proper directory structure" do
+    assert File.directory?(@recipe_name)
+  end
+
+  it "creates a new template file in markdown based on the recipe name" do
+    assert File.exist?("#{@recipe_name}/#{@recipe_name}.markdown")
+  end
+
+  after do
+    FileUtils.rm_rf(@recipe_name)
+  end
+end
+
+describe "removing a recipe" do
+  before do
+    @recipe_name = "flan"
+    Thor::Shell::Basic.any_instance.expects(:yes?).with("Warning: this will remove the directory #{@recipe_name} and all its contents. Proceed?").returns(true)
+  end
+
+  it "gives a warning that its about to delete the receipe dir and contents" do
+    capture_io { RecipeBox::CLI.start %w{ remove flan } }
+  end
+
+  it "removes the recipe's directory" do
+    FileUtils.mkdir(@recipe_name)
+    FileUtils.touch("#{@recipe_name}/#{@recipe_name}.markdown")
+    assert File.directory?(@recipe_name)
+    capture_io { RecipeBox::CLI.start %w{ remove flan } }
+    refute File.directory?(@recipe_name)
+  end
+
+  after do
+    FileUtils.rm_rf(@recipe_name)
+  end
+end

data/lib/recipe_box/cli.rb

@@ -0,0 +1,20 @@
+module RecipeBox
+  class CLI < Thor
+    desc "recipe_box insert NAME", "create a recipe called NAME"
+    def insert(name)
+      CreateRecipe.start([name])
+    end
+
+    desc "recipe_box remove NAME", "removes a recipe called NAME"
+    def remove(name)
+      if yes?("Warning: this will remove the directory #{name} and all its contents. Proceed?")
+        RemoveRecipe.start([name])
+      end
+    end
+
+    desc "recipe_box new NAME", "creates a directory to hold the recipes"
+    def new(name)
+      CreateRecipeBox.start([name])
+    end
+  end
+end

data/lib/recipe_box/create_recipe.rb

@@ -0,0 +1,19 @@
+module RecipeBox
+  class CreateRecipe < Thor::Group
+    include Thor::Actions
+
+    argument :name
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    def create_directory
+      empty_directory(name)
+    end
+
+    def create_recipe
+      template("../../templates/recipe.tt", "#{name}/#{name}.markdown")
+    end
+  end
+end

data/lib/recipe_box/create_recipe_box.rb

@@ -0,0 +1,15 @@
+module RecipeBox
+  class CreateRecipeBox < Thor::Group
+    include Thor::Actions
+
+    argument :name
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    def create_directory
+      empty_directory(name)
+    end
+  end
+end

data/lib/recipe_box/remove_recipe.rb

@@ -0,0 +1,15 @@
+module RecipeBox
+  class RemoveRecipe < Thor::Group
+    include Thor::Actions
+
+    argument :name
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    def remove_directory
+      remove_dir(name)
+    end
+  end
+end

data/lib/recipe_box/version.rb

@@ -0,0 +1,3 @@
+module RecipeBox
+  VERSION = "0.0.1"
+end

data/lib/recipe_box.rb

@@ -0,0 +1,10 @@
+require 'thor'
+
+require_relative "recipe_box/version"
+require_relative "recipe_box/create_recipe"
+require_relative "recipe_box/create_recipe_box"
+require_relative "recipe_box/remove_recipe"
+require_relative "recipe_box/cli"
+
+module RecipeBox
+end

data/recipe_box.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recipe_box/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "recipe_box"
+  spec.version       = RecipeBox::VERSION
+  spec.authors       = ["Josh Klina"]
+  spec.email         = ["joshua.klina@gmail.com"]
+  spec.summary       = %q{A command line app that helps manage a git repository of (cooking) recipes.}
+  spec.description      = "A command line app that generates templates for make recipes."
+  # spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor", '~> 0.19'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.2"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "mocha", "~> 1.0"
+end

data/templates/recipe.tt

@@ -0,0 +1,11 @@
+# Placeholder
+
+## Ingredients
+
+* _List your ingredients here_
+
+## Instructions
+
+## Sources
+
+Put any references here.

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require_relative '../lib/recipe_box'

data/test/test_recipe_box.rb

@@ -0,0 +1,11 @@
+require_relative 'helper'
+
+class TestRecipeBox < MiniTest::Unit::TestCase
+  def test_new_creates_directory
+    assert_equal true, RecipeBox.new("abba")
+  end
+
+  def test_sanitize_filename_replaces_spaces_w_underscores
+    assert_equal "hello_test", RecipeBox.sanitize_filename("hello test")
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: recipe_box
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Klina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A command line app that generates templates for make recipes.
+email:
+- joshua.klina@gmail.com
+executables:
+- recipe_box
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/recipe_box
+- features/helper.rb
+- features/recipe_box_spec.rb
+- lib/recipe_box.rb
+- lib/recipe_box/cli.rb
+- lib/recipe_box/create_recipe.rb
+- lib/recipe_box/create_recipe_box.rb
+- lib/recipe_box/remove_recipe.rb
+- lib/recipe_box/version.rb
+- recipe_box.gemspec
+- templates/recipe.tt
+- test/helper.rb
+- test/test_recipe_box.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A command line app that helps manage a git repository of (cooking) recipes.
+test_files:
+- features/helper.rb
+- features/recipe_box_spec.rb
+- test/helper.rb
+- test/test_recipe_box.rb