command_kit 0.1.0.pre1

data/spec/xdg_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+require 'command_kit/xdg'
+
+describe XDG do
+  module TestXDG
+    class TestCommand
+      include CommandKit::XDG
+    end
+  end
+
+  let(:command_class) { TestXDG::TestCommand }
+  subject { command_class.new }
+
+  describe ".xdg_namespace" do
+    subject { command_class }
+
+    context "when no xdg_namespace has been defined" do
+      it "must default to the .command_name" do
+        expect(subject.xdg_namespace).to eq(subject.command_name)
+      end
+    end
+
+    context "when an xdg_namespace has been defined in a super-class" do
+      module TestXDG
+        class SuperClassWithXDGNamespace
+          include CommandKit::XDG
+
+          xdg_namespace 'foo'
+        end
+
+        class SubClassWithoutXDGNamespace < SuperClassWithXDGNamespace
+        end
+      end
+
+      let(:command_superclass) { TestXDG::SuperClassWithXDGNamespace }
+      let(:command_class) { TestXDG::SubClassWithoutXDGNamespace }
+
+      it "must default to the superclass'es .xdg_namespace" do
+        expect(subject.xdg_namespace).to eq(command_superclass.xdg_namespace)
+      end
+
+      context "but the sub-class also defines an .xdg_namespace" do
+        module TestXDG
+          class SubClassWithXDGNamespace < SuperClassWithXDGNamespace
+
+            xdg_namespace 'bar'
+
+          end
+        end
+
+        let(:command_class) { TestXDG::SubClassWithXDGNamespace }
+
+        it "must return the subclass'es .xdg_namespace" do
+          expect(command_class.xdg_namespace).to eq('bar')
+        end
+
+        it "must not override the superclass'es .xdg_namespace" do
+          expect(command_superclass.xdg_namespace).to eq('foo')
+        end
+      end
+    end
+  end
+  
+  describe "#xdg_namespace" do
+    it "must return .xdg_namespace" do
+      expect(subject.xdg_namespace).to eq(command_class.xdg_namespace)
+    end
+  end
+
+  let(:xdg_config_home) { '/path/to/.config'      }
+  let(:xdg_data_home)   { '/path/to/.local/share' }
+  let(:xdg_cache_home)  { '/path/to/.cache'       }
+
+  describe "#initialize" do
+    let(:xdg_namespace) { subject.xdg_namespace }
+
+    context "when env: contains 'XDG_CONFIG_HOME'" do
+      let(:env) do
+        {'XDG_CONFIG_HOME' => xdg_config_home}
+      end
+
+      subject { command_class.new(env: env) }
+
+      it "must initialize #config_dir to '$XDG_CONFIG_HOME/<xdg_namespace>'" do
+        expect(subject.config_dir).to eq(
+          File.join(xdg_config_home,xdg_namespace)
+        )
+      end
+    end
+
+    context "when env: does not contains 'XDG_DATA_HOME'" do
+      it "must initialize #config_dir to '$HOME/.config/<xdg_namespace>'" do
+        expect(subject.config_dir).to eq(
+          File.join(subject.home_dir,'.config',subject.xdg_namespace)
+        )
+      end
+    end
+
+    context "when env: contains 'XDG_DATA_HOME'" do
+      let(:env) do
+        {'XDG_DATA_HOME' => xdg_data_home}
+      end
+
+      subject { command_class.new(env: env) }
+
+      it "must initialize #local_share_dir to '$XDG_DATA_HOME/<xdg_namespace>'" do
+        expect(subject.local_share_dir).to eq(
+          File.join(xdg_data_home,xdg_namespace)
+        )
+      end
+    end
+
+    context "when env: does not contains 'XDG_DATA_HOME'" do
+      it "must initialize #local_share_dir to '$HOME/.local/share/<xdg_namespace>'" do
+        expect(subject.local_share_dir).to eq(
+          File.join(subject.home_dir,'.local','share',xdg_namespace)
+        )
+      end
+    end
+
+    context "when env: contains 'XDG_CACHE_HOME'" do
+      let(:env) do
+        {'XDG_CACHE_HOME' => xdg_cache_home}
+      end
+
+      subject { command_class.new(env: env) }
+
+      it "must initialize #cache_dir to '$XDG_CACHE_HOME/<xdg_namespace>'" do
+        expect(subject.cache_dir).to eq(
+          File.join(xdg_cache_home,xdg_namespace)
+        )
+      end
+    end
+
+    context "when env: does not contains 'XDG_CACHE_HOME'" do
+      it "must initialize #cache_dir to '$HOME/.cache/<xdg_namespace>'" do
+        expect(subject.cache_dir).to eq(
+          File.join(subject.home_dir,'.cache',xdg_namespace)
+        )
+      end
+    end
+  end
+
+  describe "#config_dir" do
+    let(:env) do
+      {'XDG_CONFIG_HOME' => xdg_config_home}
+    end
+
+    subject { command_class.new(env: env) }
+
+    let(:xdg_namespace) { subject.xdg_namespace }
+
+    it "must return the initialized #config_dir" do
+      expect(subject.config_dir).to eq(
+        File.join(xdg_config_home,xdg_namespace)
+      )
+    end
+  end
+
+  describe "#local_share_dir" do
+    let(:env) do
+      {'XDG_DATA_HOME' => xdg_data_home}
+    end
+
+    subject { command_class.new(env: env) }
+
+    let(:xdg_namespace) { subject.xdg_namespace }
+
+    it "must return the initialized #local_share_dir" do
+      expect(subject.local_share_dir).to eq(
+        File.join(xdg_data_home,xdg_namespace)
+      )
+    end
+  end
+
+  describe "#cache_dir" do
+    let(:env) do
+      {'XDG_CACHE_HOME' => xdg_cache_home}
+    end
+
+    subject { command_class.new(env: env) }
+
+    let(:xdg_namespace) { subject.xdg_namespace }
+
+    it "must return the initialized #cache_dir" do
+      expect(subject.cache_dir).to eq(
+        File.join(xdg_cache_home,xdg_namespace)
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: command_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Ruby toolkit for building clean, correct, and robust CLI commands as
+  Ruby classes.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- command_kit.gemspec
+- gemspec.yml
+- lib/command_kit.rb
+- lib/command_kit/arguments.rb
+- lib/command_kit/arguments/argument.rb
+- lib/command_kit/arguments/argument_value.rb
+- lib/command_kit/arguments/usage.rb
+- lib/command_kit/colors.rb
+- lib/command_kit/command.rb
+- lib/command_kit/command_name.rb
+- lib/command_kit/commands.rb
+- lib/command_kit/commands/auto_load.rb
+- lib/command_kit/commands/auto_load/subcommand.rb
+- lib/command_kit/commands/auto_require.rb
+- lib/command_kit/commands/command.rb
+- lib/command_kit/commands/help.rb
+- lib/command_kit/commands/parent_command.rb
+- lib/command_kit/commands/subcommand.rb
+- lib/command_kit/console.rb
+- lib/command_kit/description.rb
+- lib/command_kit/env.rb
+- lib/command_kit/env/home.rb
+- lib/command_kit/env/path.rb
+- lib/command_kit/examples.rb
+- lib/command_kit/exception_handler.rb
+- lib/command_kit/help.rb
+- lib/command_kit/help/man.rb
+- lib/command_kit/inflector.rb
+- lib/command_kit/main.rb
+- lib/command_kit/options.rb
+- lib/command_kit/options/option.rb
+- lib/command_kit/options/option_value.rb
+- lib/command_kit/options/parser.rb
+- lib/command_kit/options/quiet.rb
+- lib/command_kit/options/usage.rb
+- lib/command_kit/options/verbose.rb
+- lib/command_kit/options/version.rb
+- lib/command_kit/os.rb
+- lib/command_kit/pager.rb
+- lib/command_kit/printing.rb
+- lib/command_kit/printing/indent.rb
+- lib/command_kit/program_name.rb
+- lib/command_kit/stdio.rb
+- lib/command_kit/usage.rb
+- lib/command_kit/version.rb
+- lib/command_kit/xdg.rb
+- spec/arguments/argument_spec.rb
+- spec/arguments/argument_value_spec.rb
+- spec/arguments_spec.rb
+- spec/colors_spec.rb
+- spec/command_kit_spec.rb
+- spec/command_name_spec.rb
+- spec/command_spec.rb
+- spec/commands/auto_load/subcommand_spec.rb
+- spec/commands/auto_load_spec.rb
+- spec/commands/auto_require_spec.rb
+- spec/commands/fixtures/test_auto_load/cli/commands/test1.rb
+- spec/commands/fixtures/test_auto_load/cli/commands/test2.rb
+- spec/commands/fixtures/test_auto_require/lib/test_auto_require/cli/commands/test1.rb
+- spec/commands/help_spec.rb
+- spec/commands/parent_command_spec.rb
+- spec/commands/subcommand_spec.rb
+- spec/commands_spec.rb
+- spec/console_spec.rb
+- spec/description_spec.rb
+- spec/env/home_spec.rb
+- spec/env/path_spec.rb
+- spec/env_spec.rb
+- spec/examples_spec.rb
+- spec/exception_handler_spec.rb
+- spec/help_spec.rb
+- spec/inflector_spec.rb
+- spec/main_spec.rb
+- spec/options/option_spec.rb
+- spec/options/option_value_spec.rb
+- spec/options/parser_spec.rb
+- spec/options_spec.rb
+- spec/os_spec.rb
+- spec/pager_spec.rb
+- spec/printing/indent_spec.rb
+- spec/printing_spec.rb
+- spec/program_name_spec.rb
+- spec/spec_helper.rb
+- spec/stdio_spec.rb
+- spec/usage_spec.rb
+- spec/xdg_spec.rb
+homepage: https://github.com/postmodern/command_kit#readme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A toolkit for building Ruby CLI commands
+test_files: []