bloc 0.0.5 → 0.0.6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.0.6
+
+* manifest class, plus Course and Chapter models
+* "bloc generate" command
+* parse returns a manifest instance
+* to_h mixin for course and chapter
+* hash_constructed mixin for course and chapter constructors
+
 ### 0.0.5
 
 * patch verification no longer interferes with your git history (or cares about it)

data/bin/bloc

@@ -4,12 +4,24 @@ require "rubygems"
 require "bundler/setup"
 require "bloc"
 
-if ARGV.length == 1 && ARGV.first == "validate"
+commands = {
+  'validate' => proc { Bloc::Command::Validate.run },
+  'generate' => proc { Bloc::Command::Generate.run }
+}
+if ARGV.length == 1 && commands.keys.include?(ARGV.first.downcase)
   begin
-    Bloc::Command::Validate.run
+    commands[ARGV.first.downcase].call
   rescue => e
     puts e
   end
 else
-  raise "Usage: bloc validate"
+  helpstring = <<-eos
+    Usage: 
+      bloc <command> [options]
+    
+    Commands:
+      validate
+      generate ["Course name"]  
+eos
+  puts helpstring
 end

data/lib/bloc.rb

@@ -5,6 +5,7 @@ require "json"
 
 require "bloc/version"
 require "bloc/command"
+require "bloc/models"
 
 module Bloc
 end

data/lib/bloc/command.rb

@@ -1,6 +1,11 @@
-require "bloc/command/validate"
+require "bloc/command/validate.rb"
+require "bloc/command/generate.rb"
+require "bloc/models.rb"
+require "bloc/manifest.rb"
 
 module Bloc
   module Command
   end
+
+
 end

data/lib/bloc/command/generate.rb

@@ -0,0 +1,12 @@
+module Bloc
+  module Command
+    class Generate
+      def self.run(*args)
+        course = Bloc::Models::Course.new(:name => "My course", :description => "")
+        chapters = []
+        manifest = Bloc::Manifest.new({"course" => course, "chapters" => chapters})
+        manifest.write
+      end
+    end
+  end
+end

data/lib/bloc/command/validate.rb

@@ -1,10 +1,6 @@
 module Bloc
   module Command
     class Validate
-      MANIFEST_NOT_FOUND = "Unable to find Bloc Manifest in bloc/bloc_manifest.json".red
-      MANIFEST_PATH = File.join("bloc", "bloc_manifest.json")
-      INVALID_MANIFEST = "Invalid JSON in Bloc Manifest: #{MANIFEST_PATH}".red
-      VALID_MANIFEST = "Valid Bloc Manifest".green
       NO_DEFAULT_COURSE_FILE = "No default file for course specified (OK)".green
       VALID_DEFAULT_COURSE_FILE = "Default file for course exists (OK)".green
       INVALID_DEFAULT_COURSE_FILE = "Default file for course does not exist (expected %s)".red
@@ -14,27 +10,15 @@ module Bloc
       NO_SUCH_PATCH = "Patch not found: %s".red
 
       def self.run(*args)
-        manifest = parse_manifest
+        manifest = Manifest.parse
         check_course_default_file manifest
         check_chapter_default_files manifest
         check_patches manifest
       end
 
-      def self.parse_manifest
-        raise MANIFEST_NOT_FOUND unless File.exists?(MANIFEST_PATH)
-        manifest_raw = File.read(MANIFEST_PATH)
-
-        begin
-          manifest = JSON.parse(manifest_raw)
-          puts VALID_MANIFEST
-        rescue
-          raise INVALID_MANIFEST
-        end
-        manifest
-      end
 
       def self.check_course_default_file(manifest)
-        course_default_file = manifest["default_file"]
+        course_default_file = manifest.course.default_file
         if course_default_file.nil?
           puts NO_DEFAULT_COURSE_FILE
         else
@@ -47,14 +31,14 @@ module Bloc
       end
 
       def self.check_chapter_default_files(manifest)
-        manifest["chapters"].each do |chapter|
-          if chapter["default_file"].nil?
-            puts NO_DEFAULT_CHAPTER_FILE % chapter["name"]
+        manifest.chapters.each do |chapter|
+          if chapter.default_file.nil?
+            puts NO_DEFAULT_CHAPTER_FILE % chapter.name
           else
-            if File.exists? chapter["default_file"]
-              puts VALID_DEFAULT_CHAPTER_FILE % chapter["name"]
+            if File.exists? chapter.default_file
+              puts VALID_DEFAULT_CHAPTER_FILE % chapter.name
             else
-              raise INVALID_DEFAULT_CHAPTER_FILE % [chapter["name"], chapter["default_file"]]
+              raise INVALID_DEFAULT_CHAPTER_FILE % [chapter.name, chapter.default_file]
             end
           end
         end
@@ -67,14 +51,14 @@ module Bloc
           `git init`
           `git add .`
           `git commit -m "initial"`
-          manifest["chapters"].each do |chapter|
-            patch = chapter["patch"]
+          manifest.chapters.each do |chapter|
+            patch = chapter.patch
             unless patch.nil? # technically this should be validated earlier
               unless File.exists?("bloc/#{patch}")
                 raise NO_SUCH_PATCH % patch
               end
               puts `patch < bloc/#{patch}`
-              puts `#{chapter["command"]}`
+              puts `#{chapter.command}`
             end
           end
         rescue Exception => e

data/lib/bloc/hash_constructed.rb

@@ -0,0 +1,5 @@
+module HashConstructed
+ def initialize(h)
+   h.each {|k,v| send("#{k}=",v)}
+ end
+end

data/lib/bloc/manifest.rb

@@ -0,0 +1,52 @@
+require "bloc/hash_constructed.rb"
+require "bloc/models.rb"
+
+module Bloc
+  class Manifest
+    MANIFEST_NOT_FOUND = "Unable to find Bloc Manifest in bloc/bloc_manifest.json".red
+    MANIFEST_PATH = File.join("bloc", "bloc_manifest.json")
+    INVALID_MANIFEST = "Invalid JSON in Bloc Manifest: #{MANIFEST_PATH}".red
+    VALID_MANIFEST = "Valid Bloc Manifest".green
+
+    attr_accessor :course, :chapters
+
+    def initialize(options)
+      @course = options["course"]
+      @chapters = options["chapters"]
+    end
+
+    def write
+      File.open(MANIFEST_PATH, "w") do |file|
+        file.write(JSON.pretty_generate(to_h))
+      end
+    end
+
+    def to_h
+      hash = {}
+      hash["course"] = @course.to_h
+      hash["chapters"] = []
+      @chapters.each do |chapter|
+        hash["chapters"] << chapter.to_h
+      end
+      hash
+    end
+
+    def self.parse
+      raise MANIFEST_NOT_FOUND unless File.exists?(MANIFEST_PATH)
+      manifest_raw = File.read(MANIFEST_PATH)
+
+      begin
+        manifest = JSON.parse(manifest_raw)
+        puts VALID_MANIFEST
+      rescue
+        raise INVALID_MANIFEST
+      end
+      course = Bloc::Models::Course.new(manifest["course"])
+      chapters = []
+      manifest["chapters"].each do |chapter|
+        chapters << Bloc::Models::Chapter.new(chapter)
+      end
+      Manifest.new({"course" => course, "chapters" => chapters})
+    end
+  end
+end

data/lib/bloc/models.rb

@@ -0,0 +1,18 @@
+require 'bloc/hash_constructed.rb'
+require 'bloc/to_hash.rb'
+
+module Bloc
+  module Models
+    class Course
+      include HashConstructed
+      include ToHash
+      attr_accessor :name, :description, :default_file
+    end
+
+    class Chapter
+      include HashConstructed
+      include ToHash
+      attr_accessor :name, :command, :markdown, :default_file, :patch, :cursor_row, :cursor_column
+    end
+  end
+end

data/lib/bloc/to_hash.rb

@@ -0,0 +1,9 @@
+module ToHash
+  def to_h
+    hash = {}
+    self.instance_variables.each do |var|
+      hash[var.to_s.delete("@")] = self.instance_variable_get(var)
+    end
+    hash
+  end
+end

data/lib/bloc/version.rb

@@ -1,3 +1,3 @@
 module Bloc
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bloc
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-03 00:00:00.000000000Z
+date: 2012-03-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70193289360920 !ruby/object:Gem::Requirement
+  requirement: &70226654954220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70193289360920
+  version_requirements: *70226654954220
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70193276398960 !ruby/object:Gem::Requirement
+  requirement: &70226654953800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70193276398960
+  version_requirements: *70226654953800
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70193276398540 !ruby/object:Gem::Requirement
+  requirement: &70226654953380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70193276398540
+  version_requirements: *70226654953380
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70193276398120 !ruby/object:Gem::Requirement
+  requirement: &70226654952960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193276398120
+  version_requirements: *70226654952960
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &70193276397700 !ruby/object:Gem::Requirement
+  requirement: &70226654952540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +66,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193276397700
+  version_requirements: *70226654952540
 description: A command-line tool for Bloc
 email:
 - roshan.choxi@gmail.com
@@ -86,7 +86,12 @@ files:
 - bloc.gemspec
 - lib/bloc.rb
 - lib/bloc/command.rb
+- lib/bloc/command/generate.rb
 - lib/bloc/command/validate.rb
+- lib/bloc/hash_constructed.rb
+- lib/bloc/manifest.rb
+- lib/bloc/models.rb
+- lib/bloc/to_hash.rb
 - lib/bloc/version.rb
 - spec/command/validate_spec.rb
 - spec/spec_helper.rb