jtask 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e4e1aed55bba786830b3fa70b9334dedc413096
-  data.tar.gz: 7b1b5a4fb9da48ac9af6769c7b6221f39653a945
+  metadata.gz: 0851a01dafb0753c4883abf034310c496a3181a8
+  data.tar.gz: ae407131ec5fd73379f5ffe2deeb327b7578eab1
 SHA512:
-  metadata.gz: b706543cf01b4c7ea2712d33a2e3db7120f75eeeaa64fc8049afd2bb2dc707ab0cb9127cb6e42e05cdc3402e38efdb099c2fcd1ae129bbc757f4fc53960a0f0c
-  data.tar.gz: 21584581aea94107c1a1a3315d1e30905fd5f0c7f5fdb09467dc074dca4b4fef347cd85e74410b1f76b764cefd86c2d597eab24d4aee8e88c03c9bc525911ba6
+  metadata.gz: 9de71bd836ab66469769925591e7764ba9753f81d98c7a5e6ca822cb6dafb2ff1f77dbcc13680cdd3e79b894bda54d337a140b2b0ef80e0c8ce3abf43c632673
+  data.tar.gz: 02e2d26f4009028e2cca6ca74f126ee1eec2bd7599ea4a62aab14c8e58089aceafe7be3b45077221ae81996bb8e404e56191fb99544babe76362a7ad6651b992

data/.gitignore

@@ -2,3 +2,4 @@
 tmp
 doc
 .DS_Store
+*.sublime-workspace

data/changelist.txt

@@ -1,4 +1,10 @@
-0.0.2 [Beta] [Current Version]
+0.1.0 [Beta] [Current Version]
+=====================================
+- Released a major bug fix regarding the `JTask.get()` method (see: https://github.com/adammcarthur/jtask/issues/1)
+- Minor code enhancements to the Get module.
+- Error messages have been reformatted for both web and console use.
+
+0.0.2 [Beta]
 =====================================
 - Swapped gemspec description and summary (mix up error).
 

data/jtask.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'jtask'
-  s.version     = '0.0.2'
+  s.version     = '0.1.0'
   s.platform    = Gem::Platform::RUBY
   s.date        = '2014-03-23'
   s.description = "Provides CRUD actions for JSON files, plus a few extra goodies."
@@ -12,5 +12,5 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split($/)
   s.require_paths = ["lib"]
   s.add_runtime_dependency "json", "~> 1.4"
-  s.post_install_message = "\nThanks for installing JTask Beta. Check out the full documentation and contribute at https://github.com/adammcarthur/jtask\n\n- Adam (@adammcarth)\n-"
+  s.post_install_message = "\nThanks for installing JTask Beta. Check out the full documentation and contribute at https://github.com/adammcarthur/jtask\n\nIn this release (v0.1.0 Beta): Fixed a major flaw in the JTask.get() output. Read more about this error here: https://github.com/adammcarthur/jtask/issues/1\n\n- Adam (@adammcarth)\n-"
 end

data/lib/jtask.rb

@@ -1,5 +1,5 @@
 ###########################################################################
-# ` JTask v0.0.1 Beta                                                   ` #
+# ` JTask v0.1.0 Beta                                                   ` #
 # ` Provides CRUD actions for JSON files, plus a few extra goodies.     ` #
 # ` Created by Adam McArthur (@adammcarth)                              ` #
 # ` Released under the MIT licence                                      ` #
@@ -16,7 +16,7 @@ class JTask
   modules.each do |m|
     require "jtask/#{m}"
   end
-  
+
   extend Save
   extend Get
   extend Update

data/lib/jtask/chop.rb

@@ -10,7 +10,7 @@ module Chop
 
     # Quality control - ensure paramter is a string
     unless parameter.is_a?(String)
-      raise SyntaxError, "The chop() method can only remove one parameter at a time\n               - only a string can be used to specify the parameter.\n\n-"
+      raise SyntaxError, "[JTask] The chop() method can only remove one parameter at a time - only a string can be used to specify the parameter."
     end
 
     if id.is_a?(Integer)
@@ -20,7 +20,7 @@ module Chop
         insert = objects
         insert["#{id}"] = removed_version
       else
-        raise NameError, "\n\nJTask Error => The id #{method} could not be found in the\n               file \"#{dir + filename}\". The file has not been changed.\n\n-"
+        raise NameError, "[JTask] The id #{method} could not be found in the file \"#{dir + filename}\". The file has not been changed."
       end
     elsif id == :all
       # Parameter must be removed from all objects
@@ -30,7 +30,7 @@ module Chop
       end
     insert = objects
     else
-      raise NameError, "/n/nJTask Error => Incorrect id method used. A single id (integer) can be specified,\n               or the symbol \":all\" to remove the parameter from every object.\n\n-"
+      raise NameError, "[JTask] Incorrect id method used. A single id (integer) can be specified, or the symbol \":all\" to remove the parameter from every object."
     end
 
      # Re-write the file with the new version.

data/lib/jtask/destroy.rb

@@ -13,7 +13,7 @@ module Destroy
       insert = objects.tap{ |x| x.delete("#{id}") }
     else
       # the id doesn't exist in the file
-      raise NameError, "\n\nJTask Error => An id of #{id} does not exsist in the file specified at\n               \"#{dir + filename}\". Nothing has been deleted.\n\n-"
+      raise NameError, "[JTask] An id of #{id} does not exsist in the file specified at \"#{dir + filename}\". Nothing has been deleted."
     end
 
     # Re-write the file with the new version.

data/lib/jtask/get.rb

@@ -1,3 +1,6 @@
+# JTask.get() by Adam McArthur
+# Retrieves stored JSON data from the file and returns a hash.
+
 module Get
   def get(filename, method=nil, dir=nil)
     # Check if user has specified a custom directory.
@@ -7,36 +10,50 @@ module Get
     end
     original_file = File.read(File.join(dir, filename))
     objects = JSON.parse(original_file)
-    
-    if method
-      # Determine if an id integer or {first: - last:} hash method has been supplied.
-      if method.is_a?(Integer)
-        # Check if 'method' (in this case the single id to retrieve) exists.
-        if objects["#{method}"]
-          output = {"id" => "#{method}"}.merge(objects["#{method}"])
-          # Old objects.select { |k, v| k == "#{method}" }
-        else
-          # id supplied doesn't exist
-          raise NameError, "\n\nJTask Error => The id #{method} could not be found in\n               the file \"#{dir + filename}\".\n\n-"
-        end
-      elsif method.is_a?(Hash)
+
+    # Work out which retrieval method is wanted.
+    # An integer indicates we want to find a single record by id.
+    # A hash indicates the first/last method has been used.
+
+    # Check for integer
+    if method.is_a?(Integer)
+      # Our method will be the id - lets alias it:
+      id = method
+
+      if objects["#{id}"]
+        output = { "id" => id.to_i }.merge(objects["#{id}"])
+      else
+        # id supplied doesn't exist
+        raise NameError, "[JTask] The id #{method} could not be found in the file \"#{dir + filename}\"."
+      end
+    else
+      # Method could be either blank, invalid or a "first/last" hash.
+      begin
+        # Treat method as a hash
+        # Assemble hashes of the required records, as specified by the user.
         if method[:first]
-          # Load the FIRST n number of objects from the file
-          output = Hash[(objects.to_a).first(method[:first].to_i)]
+          required_records = Hash[(objects.to_a).first(method[:first].to_i)]
         elsif method[:last]
-          # Load the LAST n number of objects from the file
-          output = Hash[(objects.to_a).last(method[:last].to_i).reverse] # wow!
+          required_records = Hash[(objects.to_a).last(method[:last].to_i).reverse] # wow!
+        end
+      # Rescue to prevent '[]' nil class error if method is empty
+      rescue
+        if method == nil
+          # We want all the records since no get method is supplied
+          required_records = objects
         else
-          raise NameError, "\n\nJTask Error => Invalid get method specified. Try using\n               JTask.get(\"filename\", last: 10) instead.\n\n-" 
+          # Unrecognisable value used as the method, crash immediatly.
+          raise SyntaxError, "[JTask] Invalid value given for the get method."
         end
-      else
-        raise NameError, "\n\nJTask Error => Invalid get method specified. Try using\n               JTask.get(\"filename\", 1) instead.\n\n-"
       end
-    else
-      # No retrieval method supplied, so output all the objects from the file :)
-      output = objects
+      # Loop through each required record and
+      # push each one to the blank output array.
+      output = []
+      required_records.each do |id, record|
+        output.push({ "id" => id.to_i }.merge(record))
+      end
     end
-    
+
     return output
   end
 end

data/lib/jtask/save.rb

@@ -12,7 +12,7 @@ module Save
     end
     # Validate haash supplied for parameters
     unless parameters.is_a?(Hash)
-      raise SyntaxError, "\n\nJTask Error => Invalid value supplied to the parameters variable.\n               Ensure your parameters are in a symbol hash form\n               like - {name: \"Adam\", city: \"Melbourne\"}\n\n-"
+      raise SyntaxError, "[JTask] Invalid value supplied to the parameters variable. Ensure your parameters are in the symbol hash form, eg - {name: \"Adam\", city: \"Melbourne\"}"
     end
     
     original_file = File.read(File.join(dir, filename))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jtask
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam McArthur
@@ -30,13 +30,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
 - changelist.txt
 - jtask.gemspec
-- lib/.DS_Store
 - lib/jtask.rb
-- lib/jtask/.DS_Store
 - lib/jtask/chop.rb
 - lib/jtask/destroy.rb
 - lib/jtask/get.rb
@@ -55,6 +52,8 @@ post_install_message: |2-
 
   Thanks for installing JTask Beta. Check out the full documentation and contribute at https://github.com/adammcarthur/jtask
 
+  In this release (v0.1.0 Beta): Fixed a major flaw in the JTask.get() output. Read more about this error here: https://github.com/adammcarthur/jtask/issues/1
+
   - Adam (@adammcarth)
   -
 rdoc_options: []