keepass_kpscript 1.0.0

data/spec/keepass_kpscript_test/tests/keepass_kpscript/select_spec.rb

@@ -0,0 +1,61 @@
+describe KeepassKpscript::Select do
+
+  shared_examples 'a selector' do
+
+    subject(:selector) { KeepassKpscript.use('/path/to/KPScript.exe', debug: debug).select }
+
+    {
+      proc { |s| s.fields(Field: 'Value') } => '-ref-Field:"Value"',
+      proc { |s| s.fields(Field1: 'Value1', Field2: 'Value2') } => '-ref-Field1:"Value1" -ref-Field2:"Value2"',
+      proc { |s| s.fields(Field1: 'Value1').fields(Field2: 'Value2') } => '-ref-Field1:"Value1" -ref-Field2:"Value2"',
+      proc { |s| s.uuid('MyUUID') } => '-refx-UUID:MyUUID',
+      proc { |s| s.tags %w[tag1 tag2] } => '-refx-Tags:"tag1,tag2"',
+      proc { |s| s.tags(*%w[tag1 tag2]) } => '-refx-Tags:"tag1,tag2"',
+      proc { |s| s.expires } => '-refx-Expires:true',
+      proc { |s| s.expires(false) } => '-refx-Expires:false',
+      proc { |s| s.expired } => '-refx-Expired:true',
+      proc { |s| s.expired(false) } => '-refx-Expired:false',
+      proc { |s| s.group('MyGroup') } => '-refx-Group:"MyGroup"',
+      proc { |s| s.group_path %w[Group1 Group2 Group3] } => '-refx-GroupPath:"Group1/Group2/Group3"',
+      proc { |s| s.group_path(*%w[Group1 Group2 Group3]) } => '-refx-GroupPath:"Group1/Group2/Group3"',
+      proc { |s| s.all } => '-refx-All',
+      proc do |s|
+        # Check here that all methods are chainable
+        s.
+          group('MyGroup').
+          expires.
+          expired(false).
+          tags('MyTag').
+          fields(Field: 'Value').
+          uuid('MyUUID').
+          group_path(%w[Group1 Group2]).
+          all.
+          fields(Field1: 'Value1', Field2: 'Value2')
+      end => '-refx-Group:"MyGroup" -refx-Expires:true -refx-Expired:false -refx-Tags:"MyTag" -ref-Field:"Value" -refx-UUID:MyUUID -refx-GroupPath:"Group1/Group2" -refx-All -ref-Field1:"Value1" -ref-Field2:"Value2"'
+    }.each.with_index do |(select_block, expected_args), example_idx|
+
+      it "selects #{expected_args} (example ##{example_idx})" do
+        expect(select_block.call(selector).to_s).to eq expected_args
+      end
+
+    end
+
+  end
+
+  context 'without debug' do
+
+    it_behaves_like 'a selector' do
+      let(:debug) { false }
+    end
+
+  end
+
+  context 'with debug' do
+
+    it_behaves_like 'a selector' do
+      let(:debug) { true }
+    end
+
+  end
+
+end

data/spec/keepass_kpscript_test/tests/rubocop_spec.rb

@@ -0,0 +1,31 @@
+require 'json'
+
+describe 'Coding guidelines' do
+
+  it 'makes sure code style follow Rubocop guides' do
+    rubocop_report = JSON.parse(`bundle exec rubocop --format json`)
+    expect(rubocop_report['summary']['offense_count']).to(
+      eq(0),
+      proc do
+        # Format a great error message to help
+        wrong_files = rubocop_report['files'].reject { |file_info| file_info['offenses'].empty? }
+        <<~EO_ERROR
+          #{wrong_files.size} files have Rubocop issues:
+          #{
+            wrong_files.map do |file_info|
+              offenses = file_info['offenses'].map { |offense_info| "L#{offense_info['location']['start_line']}: #{offense_info['cop_name']} - #{offense_info['message']}" }
+              "* #{file_info['path']}:#{
+                if offenses.size == 1
+                  " #{offenses.first}"
+                else
+                  " #{offenses.size} offenses:\n#{offenses.map { |offense| "  - #{offense}" }.join("\n")}"
+                end
+              }"
+            end.join("\n")
+          }
+        EO_ERROR
+      end
+    )
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+require 'keepass_kpscript_test/helpers'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  # config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = "doc"
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  # Kernel.srand config.seed
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: keepass_kpscript
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Muriel Salvan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: secret_string
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: sem_ver_components
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: Ruby API to handle Keepass databases using KPScript
+email:
+- muriel@x-aeon.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- README.md
+- lib/keepass_kpscript.rb
+- lib/keepass_kpscript/database.rb
+- lib/keepass_kpscript/kpscript.rb
+- lib/keepass_kpscript/pass_encryptor.kdbx
+- lib/keepass_kpscript/select.rb
+- lib/keepass_kpscript/version.rb
+- spec/keepass_kpscript_test/helpers.rb
+- spec/keepass_kpscript_test/tests/keepass_kpscript/database_spec.rb
+- spec/keepass_kpscript_test/tests/keepass_kpscript/kpscript_spec.rb
+- spec/keepass_kpscript_test/tests/keepass_kpscript/select_spec.rb
+- spec/keepass_kpscript_test/tests/rubocop_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.7'
+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: Keepass KPScript
+test_files: []