magellan-cli 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f81ab633b90549d1474807b9924f28eb0d87fed
-  data.tar.gz: 34fd0c8d234687f1b0b3cce29cd11b48a0431992
+  metadata.gz: 4b8130a0c4a91225ff9bead118ba994a4be21351
+  data.tar.gz: eb512a27d356f8657a4e91664e4cbac15cb642a1
 SHA512:
-  metadata.gz: 26e60decb0ff48f362516b2750719d48285bb721a163f23b88bb8f6164d1e3f6262c55e9178da54cbcff89e46f59a71a78f7fea73e3560d857802405932db76f
-  data.tar.gz: fc4bb095493fd8c09f8dbc8896a9f8fa62f4b60144864c3c63feb8b5b13412fe3ed795a0f8c1c5469dabeea97a0c70522875e915a17f6f0e78fbebc117ded255
+  metadata.gz: 0f7930935c96927195eafc9ec7a93eb6d1e27bd3af2eb7984fe44e8963812a1d25a9ad64baa979a74dc9c4416c3cdb71da83f558c26c90f4436fd535d5cc1e8a
+  data.tar.gz: d79d097a744166423b27833e4eaf92b5cec812d47d0e9f103c83525d32a822ba3791c6064b23cfaf976dec5d88d4ed27e297fb7342c5d3e951419fef18ac4658

data/Gemfile

@@ -7,4 +7,5 @@ group :development do
   gem "pry"
   gem "pry-byebug"
   gem "pry-stack_explorer"
+  gem "simplecov"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    magellan-cli (0.4.0)
+    magellan-cli (0.4.1)
       activesupport (~> 4.1.4)
       groovenauts-thor
       httpclient (~> 2.5)
@@ -12,7 +12,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.8)
+    activesupport (4.1.9)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -28,13 +28,15 @@ GEM
     debug_inspector (0.0.2)
     debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     groovenauts-thor (0.19.1)
     httpclient (2.6.0.1)
     i18n (0.7.0)
     json (1.8.2)
     method_source (0.8.2)
     mini_portile (0.6.2)
-    minitest (5.5.0)
+    minitest (5.5.1)
+    multi_json (1.10.1)
     nokogiri (1.6.5)
       mini_portile (~> 0.6.0)
     pry (0.9.12.6)
@@ -60,6 +62,11 @@ GEM
     rspec-mocks (3.0.4)
       rspec-support (~> 3.0.0)
     rspec-support (3.0.4)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
     slop (3.5.0)
     text-table (1.2.3)
     thread_safe (0.3.4)
@@ -77,3 +84,4 @@ DEPENDENCIES
   pry-stack_explorer
   rake (~> 10.0)
   rspec
+  simplecov

data/lib/magellan/cli/command.rb

@@ -11,6 +11,7 @@ module Magellan
       class << self
         # override Thor::Base.start method
         def start(given_args = ARGV, config = {})
+          Magellan::Cli::FileAccess.ensure_config_dir
           # class_options verbose and version are defined in Magellan::Cli::Base
           if (ARGV == ["-v"] || ARGV == ["--version"])
             log_info(File.basename($0) << " " << Magellan::Cli::VERSION)

data/lib/magellan/cli/file_access.rb

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+require "fileutils"
+
 module Magellan
   module Cli
     module FileAccess
@@ -7,16 +9,31 @@ module Magellan
       class NotSelected < StandardError
       end
 
-      SELECTION_FILENAME = ".magellan-cli"
+      DEFAULT_SELECTION_FILENAME = File.expand_path("~/.config/magellan/magellan-cli")
 
       module_function
 
+      def selection_filename
+        ENV["MAGELLAN_CLI_CONFIG_FILE"] || DEFAULT_SELECTION_FILENAME
+      end
+
       def remove_selection_file
-        File.exist?(SELECTION_FILENAME) && File.delete(SELECTION_FILENAME)
+        File.exist?(selection_filename) && File.delete(selection_filename)
       end
 
       def load_selections
-        File.readable?(SELECTION_FILENAME) ? YAML.load_file(SELECTION_FILENAME) : {}
+        File.readable?(selection_filename) ? YAML.load_file(selection_filename) : {}
+      end
+
+      # check if ~/.config/magellan directory exists.
+      def ensure_config_dir
+        return if ENV["MAGELLAN_CLI_CONFIG_FILE"]
+        default_dir = File.dirname(DEFAULT_SELECTION_FILENAME)
+        unless File.directory?(default_dir)
+          # This is notification message to be displayed at the first time magellan-cli invoked.
+          puts I18n.t(:config_file, scope: [:base, :notification])
+          FileUtils.mkdir_p(default_dir)
+        end
       end
 
       # @param [Class|String] obj Resource class or resource name
@@ -37,7 +54,11 @@ module Magellan
         sel = load_selections
         sel.update(hash) if hash
         yield(sel) if block_given?
-        open(".magellan-cli", "w") do |f|
+        filepath = selection_filename
+        unless File.exist?(File.dirname(filepath))
+          FileUtils.mkdir_p(File.dirname(filepath))
+        end
+        open(filepath, "w") do |f|
           f.chmod 0600
           YAML.dump(sel, f)
         end

data/lib/magellan/cli/locales/en.yml

@@ -1,5 +1,20 @@
 en:
   base:
+    notification:
+      config_file: |
+        ******* magellan-cli configuration file ******
+        magellan-cli stores login information, resources selection information into
+        a configuration file. The file path of the configuration file is usually
+        ${HOME}/.config/magellan/magellan-cli
+        You can specify your own configuration file path by setting environment variable
+        MAGELLAN_CLI_CONFIG_FILE.
+        
+        !! migration from 0.4.0 and before !!
+        magellan-cli 0.4.0 and before saves configuration file into `.magellan-cli'
+        in current directory.
+        To migrate onfigurations from magellan-0.4.0 and before, move `.magellan-cli'
+        file in the working directory to ${HOME}/.config/magellan/magellan-cli or
+        ${MAGELLAN_CLI_CONFIG_FILE}.
     cmd:
       help: "Describe available commands or one specific command"
   command:

data/lib/magellan/cli/locales/ja.yml

@@ -1,5 +1,18 @@
 ja:
   base:
+    notification:
+      config_file: |
+        ******* magellan-cli の設定ファイル ******
+        magellan-cli はログイン情報、リソースの選択状態などの情報を設定ファイルに保存します。
+        設定ファイルのファイルパスは ${HOME}/.config/magellan/magellan-cli が用いられます。
+        設定ファイルのファイルパスは環境変数 MAGELLAN_CLI_CONFIG_FILE で指定可能です。
+        
+        !! 0.4.0 からの移行について !!
+        magellan-cli 0.4.0 までは設定ファイルとしてカレントディレクトリに .magellan-cli ファイルを
+        作成していました。
+        0.4.0 以前のバージョンからの移行のためには、作業ディレクトリ内の .magellan-cli ファイルを
+        ${HOME}/.config/magellan/magellan-cli もしくは環境変数 MAGELLAN_CLI_CONFIG_FILE で指定する
+        パスへ移動してください。
     cmd:
       help: "利用可能なコマンドの一覧か特定のコマンドの説明を表示します"
   command:

data/lib/magellan/cli/version.rb

@@ -1,5 +1,5 @@
 module Magellan
   module Cli
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

data/spec/magellan/cli/file_access_spec.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Magellan::Cli::FileAccess do
+  describe :ensure_config_dir do
+    before do
+      @stdout = StringIO.new
+      @stdout_orig, $stdout = $stdout, @stdout
+      expect(File).to receive(:directory?).with(File.expand_path("~/.config/magellan")).and_return(false)
+      expect(FileUtils).to receive(:mkdir_p).with(File.expand_path("~/.config/magellan"))
+      @magellan_cli_config_file_orig, ENV["MAGELLAN_CLI_CONFIG_FILE"] = ENV["MAGELLAN_CLI_CONFIG_FILE"], nil
+    end
+    after do
+      $stdout = @stdout_orig
+      ENV["MAGELLAN_CLI_CONFIG_FILE"] = @magellan_cli_config_file_orig
+    end
+    it "print notification message" do
+      Magellan::Cli::FileAccess.ensure_config_dir
+      [
+        %r{\.config/magellan/magellan-cli },
+        %r{configuration file}i,
+        %r{environment variable}i,
+        %r{MAGELLAN_CLI_CONFIG_FILE},
+        %r{migration}i,
+      ].each do |re|
+        expect(@stdout.string).to match(re)
+      end
+    end
+  end
+end

data/spec/magellan/cli/login_spec.rb

@@ -10,7 +10,7 @@ describe Magellan::Cli::Login do
 
     before do
       allow(File).to receive(:readable?).and_return(true)
-      allow(YAML).to receive(:load_file).with(".magellan-cli").and_return({"login" => {"email" => email, "password" => password} })
+      allow(YAML).to receive(:load_file).with(ENV["MAGELLAN_CLI_CONFIG_FILE"]).and_return({"login" => {"email" => email, "password" => password} })
     end
 
     context :production do

data/spec/spec_helper.rb

@@ -1,2 +1,12 @@
+require "pry"
+
+if ENV["COVERAGE"] =~ /true|yes|on|1/i
+  require "simplecov"
+  SimpleCov.start :rails
+end
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'magellan/cli'
+
+ENV["MAGELLAN_CLI_CONFIG_FILE"] = File.expand_path("../.magellan-cli", __FILE__)
+I18n.locale = :en

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magellan-cli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - akm2000
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -186,6 +186,7 @@ files:
 - magellan-cli.gemspec
 - spec/magellan/cli/Magellan.yml
 - spec/magellan/cli/command_spec.rb
+- spec/magellan/cli/file_access_spec.rb
 - spec/magellan/cli/login_page.html
 - spec/magellan/cli/login_spec.rb
 - spec/magellan/cli/resources/client_version_spec.rb
@@ -222,6 +223,7 @@ summary: commandline tools for magellanic cloud service.
 test_files:
 - spec/magellan/cli/Magellan.yml
 - spec/magellan/cli/command_spec.rb
+- spec/magellan/cli/file_access_spec.rb
 - spec/magellan/cli/login_page.html
 - spec/magellan/cli/login_spec.rb
 - spec/magellan/cli/resources/client_version_spec.rb