arcanus 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c203a66cb5ef34e876084ba7aabd877ee6228816
-  data.tar.gz: c2af0b10865835de171ecfcf8ec3897ace3b6cdb
+  metadata.gz: 66036810d6ca7fa05522b32afeb91c36dfe96f4a
+  data.tar.gz: b38269a7f63c805c89c3da2824bbe81f773dac86
 SHA512:
-  metadata.gz: c30600d873ed37082854aa17f149dcac96d7fb467fe9a9bb271c8a5ffe16f3dcce03f2f098c0f32761c9eecbfed02d4df500eb5263490eb6e83a059fe3948dec
-  data.tar.gz: bf2b007a2efc9f4263928ac96be9da2a1867dd01b962b1996742fd058db7d72c9b6a68dfb48fc2be7217fcacc32de32f22b57443e065ca4e691a69f39c657549
+  metadata.gz: a778447c3785bf38d80a6473edbe60833e665a990d9e1df5aa81727e49d73bcbed5bbe1fc227126c3fba0442fa64fa5e7700843f53ec2078a4ef55c559f7a538
+  data.tar.gz: 6de23a00c31b5b4bf63f163204f8152b746309f13db35783e72af7972624102b5ce465e67f6934b56733609a8cbcba1cba1856be6c0f0db9ecf8be1147b7e657

data/lib/arcanus/chest.rb

@@ -34,6 +34,24 @@ module Arcanus
       @hash
     end
 
+    # Provides access to chest items using regular method calls instead of hash
+    # accesses.
+    def method_missing(method_sym, *)
+      method_name = method_sym.to_s
+      if @hash.key?(method_name)
+        value = @hash[method_name]
+        if value.is_a?(Hash)
+          Item.new(value, [method_name])
+        else
+          value
+        end
+      else
+        raise KeyError,
+              "Key '#{method_name}' does not exist in this Arcanus chest",
+              caller
+      end
+    end
+
     # Set value for the specified key path.
     #
     # @param key_path [String]
@@ -71,7 +89,10 @@ module Arcanus
       modified_hash =
         process_hash_changes(@original_encrypted_hash, @original_decrypted_hash, @hash)
 
-      File.open(@chest_file_path, 'w') { |f| f.write(modified_hash.to_yaml) }
+      File.open(@chest_file_path, 'w') do |f|
+        f.puts('# Do not edit this file directly! Run `arcanus edit`')
+        f.write(modified_hash.to_yaml)
+      end
     end
 
     private
@@ -160,5 +181,58 @@ module Arcanus
 
       Marshal.load(dumped_value)
     end
+
+    # Helper class for returning contents nested hashes, exposing helpers to
+    # access them via method calls.
+    class Item
+      def initialize(hash, prefix = [])
+        @hash = hash
+        @prefix = prefix
+      end
+
+      def method_missing(method_sym, *)
+        method_name = method_sym.to_s
+        if @hash.key?(method_name)
+          value = @hash[method_name]
+          if value.is_a?(Hash)
+            Item.new(value, @prefix + [method_name])
+          else
+            value
+          end
+        else
+          key_name = "#{@prefix.join('.')}.#{method_name}"
+          raise KeyError,
+                "Key '#{key_name}' does not exist in this Arcanus chest",
+                caller
+        end
+      end
+
+      # Access the item as if it were a hash.
+      #
+      # @param key [String]
+      # @return [Object]
+      def [](key)
+        @hash[key]
+      end
+
+      # Fetch key from the chest as if it were a hash.
+      def fetch(*args)
+        @hash.fetch(*args)
+      end
+
+      def to_s
+        @hash.to_s
+      end
+
+      def inspect
+        @hash.inspect
+      end
+
+      # Implicit conversion to array. Needs to be defined so we can `puts` this
+      # value.
+      def to_ary
+        [@hash]
+      end
+    end
   end
 end

data/lib/arcanus/command/help.rb

@@ -24,7 +24,7 @@ module Arcanus::Command
     def command_classes
       command_files =
         Dir[File.join(File.dirname(__FILE__), '*.rb')]
-          .select { |path| File.basename(path, '.rb') != 'base' }
+        .select { |path| File.basename(path, '.rb') != 'base' }
 
       command_files.map do |file|
         require file

data/lib/arcanus/command/setup.rb

@@ -94,7 +94,13 @@ module Arcanus::Command
     end
 
     def create_chest
+      # Create a dummy file to start so that we can initialize an empty chest,
+      # but then use that chest's #save implementation to save the file
       File.open(repo.chest_file_path, 'w') { |f| f.write({}.to_yaml) }
+
+      chest = Arcanus::Chest.new(key_file_path: repo.unlocked_key_path,
+                                 chest_file_path: repo.chest_file_path)
+      chest.save
     end
 
     def create_gitignore

data/lib/arcanus/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'yaml'
 
@@ -8,7 +10,7 @@ module Arcanus
   # this logic can be shared amongst the various components of the system.
   class Configuration
     # Name of the configuration file.
-    FILE_NAME = 'config.yaml'
+    FILE_NAME = 'config.yaml'.freeze
 
     class << self
       # Loads appropriate configuration file given the current working

data/lib/arcanus/constants.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 # Global application constants.
 module Arcanus
-  EXECUTABLE_NAME = 'arcanus'
+  EXECUTABLE_NAME = 'arcanus'.freeze
 
-  CHEST_FILE_PATH = File.join('.arcanus', 'chest.yaml')
-  LOCKED_KEY_PATH = File.join('.arcanus', 'protected.key')
-  UNLOCKED_KEY_PATH = File.join('.arcanus', 'unprotected.key')
+  CHEST_FILE_PATH = File.join('.arcanus', 'chest.yaml').freeze
+  LOCKED_KEY_PATH = File.join('.arcanus', 'protected.key').freeze
+  UNLOCKED_KEY_PATH = File.join('.arcanus', 'unprotected.key').freeze
 
-  REPO_URL = 'https://github.com/sds/arcanus'
-  BUG_REPORT_URL = "#{REPO_URL}/issues"
+  REPO_URL = 'https://github.com/sds/arcanus'.freeze
+  BUG_REPORT_URL = "#{REPO_URL}/issues".freeze
 end

data/lib/arcanus/ui.rb

@@ -104,7 +104,7 @@ module Arcanus
     end
 
     # Execute a command with a spinner animation until it completes.
-    def spinner(*args, &block)
+    def spinner(*args)
       spinner = TTY::Spinner.new(*args)
       spinner_thread = Thread.new do
         loop do
@@ -113,7 +113,7 @@ module Arcanus
         end
       end
 
-      block.call
+      yield
     ensure
       spinner_thread.kill
       newline # Ensure next line of ouptut on separate line from spinner
@@ -123,9 +123,9 @@ module Arcanus
     #
     # Customize the table by passing a block and operating on the table object
     # passed to that block to add rows and customize its appearance.
-    def table(options = {}, &block)
+    def table(options = {})
       t = TTY::Table.new(options)
-      block.call(t)
+      yield t
       print(t.render(:unicode, options))
     end
   end

data/lib/arcanus/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Defines the gem version.
 module Arcanus
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arcanus
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Shane da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess