bp3-hello-world 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +27 -9
  3. data/.yardopts +8 -0
  4. data/CHANGELOG.md +10 -0
  5. data/Gemfile +1 -1
  6. data/Gemfile.lock +36 -31
  7. data/README.md +17 -8
  8. data/Rakefile +3 -3
  9. data/bp3-hello-world.gemspec +22 -22
  10. data/lib/bp3/hello/world/context.rb +1 -1
  11. data/lib/bp3/hello/world/version.rb +1 -1
  12. data/lib/bp3/hello/world.rb +3 -3
  13. data/lib/bp3-hello-world.rb +1 -1
  14. metadata +6 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fd3967917afcdaa32a7d83585ef22dca9569982664783aad2152acd4b0bca935
4
- data.tar.gz: 761634704efc97ee595d71d08eb51c44c88f048d6b75754f395f0ac1c8204d24
3
+ metadata.gz: 3748494678919b5f794c1223bd4a3ec9ad33e2f05e9d660b67863f2305541659
4
+ data.tar.gz: 5e2a764d6f24ec67a54591ce0304c2f38f3baae4e1a3b86cffafc75bb908a8fc
5
5
  SHA512:
6
- metadata.gz: 5a9bca506a7ca161160ad2dc39532a67f3d4702e47836f5e8702133b59363b5f40d7c08b0e3887f645800265d1db22eb278fb8f5ef1ce32695e5937b151640f3
7
- data.tar.gz: d5f5cd45346a853c5f2981a68b16f5e7887c7fc1fdae8a5cba73d22aa7cf5f05b1ebc3dc1cced681bca5bf452f32ee536ce7c9e3cec7c0b65998d8aef62f051b
6
+ metadata.gz: b94e00cc9834b48842190d8a9e3c6be09f66d65c98fb0826a69df22df39e33f8e149de8e4d85271f7a3ff9898ee1049b29f6d6119c76fa674011628a3be6d0ff
7
+ data.tar.gz: a2e7bf17a78330d2d7aadaa4d5cde113a75bb6f5f4b0a28e6c6e9f357a49769e3b80bb48b6c3d2fb86377dd69be551b5804bd436ecb6937290efbe6db125f6cc
data/.rubocop.yml CHANGED
@@ -1,6 +1,8 @@
1
1
  require:
2
2
  - rubocop-rake
3
3
  - rubocop-rspec
4
+ - rubocop-capybara
5
+ - rubocop-factory_bot
4
6
 
5
7
  AllCops:
6
8
  TargetRubyVersion: 3.2.2
@@ -9,17 +11,33 @@ AllCops:
9
11
  Gemspec/DevelopmentDependencies:
10
12
  EnforcedStyle: gemspec
11
13
 
14
+ Metrics/AbcSize:
15
+ Max: 26
16
+
17
+ Metrics/BlockLength:
18
+ Max: 66
19
+
20
+ Metrics/CyclomaticComplexity:
21
+ Max: 10
22
+
23
+ Metrics/MethodLength:
24
+ Max: 15
25
+
26
+ Metrics/ModuleLength:
27
+ Max: 150
28
+
29
+ Metrics/PerceivedComplexity:
30
+ Max: 10
31
+
12
32
  Naming/FileName:
13
33
  Exclude:
14
- - lib/bp3-hello-world.rb
34
+ - lib/bp3-*.rb
15
35
 
16
- Style/StringLiterals:
17
- Enabled: true
18
- EnforcedStyle: double_quotes
36
+ RSpec/ExampleLength:
37
+ Max: 10
19
38
 
20
- Style/StringLiteralsInInterpolation:
21
- Enabled: true
22
- EnforcedStyle: double_quotes
39
+ RSpec/MultipleExpectations:
40
+ Max: 4
23
41
 
24
- Layout/LineLength:
25
- Max: 120
42
+ Style/Documentation:
43
+ Enabled: false
data/.yardopts ADDED
@@ -0,0 +1,8 @@
1
+ --charset utf-8
2
+ --readme README.md
3
+ --markup markdown
4
+ --title "bp3-hello-world"
5
+ --private
6
+ -
7
+ CHANGELOG.md
8
+ LICENSE.txt
data/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  ## [Unreleased]
2
2
 
3
+ ## [0.1.4] - 2024-06-04
4
+
5
+ - Tweaks and documentation
6
+
7
+ ## [0.1.3] - 2023-11-06
8
+
9
+ ## [0.1.2] - 2023-11-06
10
+
11
+ ## [0.1.1] - 2023-11-03
12
+
3
13
  ## [0.1.0] - 2023-10-30
4
14
 
5
15
  - Initial release
data/Gemfile CHANGED
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- source "https://rubygems.org"
3
+ source 'https://rubygems.org'
4
4
 
5
5
  # Specify your gem's dependencies in bp3-hello-world.gemspec
6
6
  gemspec
data/Gemfile.lock CHANGED
@@ -1,65 +1,70 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- bp3-hello-world (0.1.3)
4
+ bp3-hello-world (0.1.4)
5
5
  i18n (>= 1.8.11, < 2)
6
6
 
7
7
  GEM
8
8
  remote: https://rubygems.org/
9
9
  specs:
10
10
  ast (2.4.2)
11
- concurrent-ruby (1.2.2)
12
- diff-lcs (1.5.0)
13
- i18n (1.14.1)
11
+ concurrent-ruby (1.3.1)
12
+ diff-lcs (1.5.1)
13
+ i18n (1.14.5)
14
14
  concurrent-ruby (~> 1.0)
15
- json (2.6.3)
15
+ json (2.7.2)
16
16
  language_server-protocol (3.17.0.3)
17
- parallel (1.23.0)
18
- parser (3.2.2.4)
17
+ parallel (1.24.0)
18
+ parser (3.3.2.0)
19
19
  ast (~> 2.4.1)
20
20
  racc
21
- racc (1.7.1)
21
+ racc (1.8.0)
22
22
  rainbow (3.1.1)
23
- rake (13.1.0)
24
- regexp_parser (2.8.2)
25
- rexml (3.2.6)
26
- rspec (3.12.0)
27
- rspec-core (~> 3.12.0)
28
- rspec-expectations (~> 3.12.0)
29
- rspec-mocks (~> 3.12.0)
30
- rspec-core (3.12.2)
31
- rspec-support (~> 3.12.0)
32
- rspec-expectations (3.12.3)
23
+ rake (13.2.1)
24
+ regexp_parser (2.9.2)
25
+ rexml (3.2.8)
26
+ strscan (>= 3.0.9)
27
+ rspec (3.13.0)
28
+ rspec-core (~> 3.13.0)
29
+ rspec-expectations (~> 3.13.0)
30
+ rspec-mocks (~> 3.13.0)
31
+ rspec-core (3.13.0)
32
+ rspec-support (~> 3.13.0)
33
+ rspec-expectations (3.13.0)
33
34
  diff-lcs (>= 1.2.0, < 2.0)
34
- rspec-support (~> 3.12.0)
35
- rspec-mocks (3.12.6)
35
+ rspec-support (~> 3.13.0)
36
+ rspec-mocks (3.13.1)
36
37
  diff-lcs (>= 1.2.0, < 2.0)
37
- rspec-support (~> 3.12.0)
38
- rspec-support (3.12.1)
39
- rubocop (1.57.2)
38
+ rspec-support (~> 3.13.0)
39
+ rspec-support (3.13.1)
40
+ rubocop (1.64.1)
40
41
  json (~> 2.3)
41
42
  language_server-protocol (>= 3.17.0)
42
43
  parallel (~> 1.10)
43
- parser (>= 3.2.2.4)
44
+ parser (>= 3.3.0.2)
44
45
  rainbow (>= 2.2.2, < 4.0)
45
46
  regexp_parser (>= 1.8, < 3.0)
46
47
  rexml (>= 3.2.5, < 4.0)
47
- rubocop-ast (>= 1.28.1, < 2.0)
48
+ rubocop-ast (>= 1.31.1, < 2.0)
48
49
  ruby-progressbar (~> 1.7)
49
50
  unicode-display_width (>= 2.4.0, < 3.0)
50
- rubocop-ast (1.30.0)
51
- parser (>= 3.2.1.0)
52
- rubocop-capybara (2.19.0)
51
+ rubocop-ast (1.31.3)
52
+ parser (>= 3.3.1.0)
53
+ rubocop-capybara (2.20.0)
54
+ rubocop (~> 1.41)
55
+ rubocop-factory_bot (2.25.1)
53
56
  rubocop (~> 1.41)
54
- rubocop-factory_bot (2.24.0)
55
- rubocop (~> 1.33)
56
57
  rubocop-rake (0.6.0)
57
58
  rubocop (~> 1.0)
58
- rubocop-rspec (2.25.0)
59
+ rubocop-rspec (2.30.0)
59
60
  rubocop (~> 1.40)
60
61
  rubocop-capybara (~> 2.17)
61
62
  rubocop-factory_bot (~> 2.22)
63
+ rubocop-rspec_rails (~> 2.28)
64
+ rubocop-rspec_rails (2.28.3)
65
+ rubocop (~> 1.40)
62
66
  ruby-progressbar (1.13.0)
67
+ strscan (3.1.0)
63
68
  unicode-display_width (2.5.0)
64
69
 
65
70
  PLATFORMS
data/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # Bp3::Hello::World
2
2
 
3
- Bp3::Hello::World is an example Bp3 plugin
3
+ bp3-hello-world is an example plugin for BP3, the persuavis/black_phoebe_3
4
+ multi-site multi-tenant rails application.
4
5
 
5
6
  ## Installation
6
7
 
@@ -19,21 +20,29 @@ Or install it yourself as:
19
20
  $ gem install bp3-hello-world
20
21
 
21
22
  ## Usage
22
-
23
+ In the Rails console:
24
+ ```ruby
23
25
  require 'bp3-hello-world'
24
26
  Bp3::Hello::World::Context.say_it!
27
+ ```
28
+ Under the hood, `#say_it!` uses the `I18n.locale`.
25
29
 
26
30
  ## Development
27
31
 
28
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
29
-
30
- You can also run `bin/console` for an interactive prompt that will allow you to experiment.
32
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec`
33
+ to run the tests. You can also run `bin/console` for an interactive prompt that will allow
34
+ you to experiment.
31
35
 
32
- To install this gem onto your local machine, run `bundle exec rake install`.
36
+ To install this gem onto your local machine, run `rake install`. To release a
37
+ new version, update the version number in `version.rb`, and then run `rake release`,
38
+ which will create a git tag for the version, push git commits and the created tag, and push
39
+ the `.gem` file to [rubygems.org](https://rubygems.org).
33
40
 
34
- ## Contributing
41
+ ## Testing
42
+ Run `rake` to run rspec tests and rubocop linting.
35
43
 
36
- Bug reports and pull requests are welcome on GitHub at https://github.com/persuavis/bp3-hello-world.
44
+ ## Documentation
45
+ A `.yardopts` file is provided to support yard documentation.
37
46
 
38
47
  ## License
39
48
 
data/Rakefile CHANGED
@@ -1,11 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require "bundler/gem_tasks"
4
- require "rspec/core/rake_task"
3
+ require 'bundler/gem_tasks'
4
+ require 'rspec/core/rake_task'
5
5
 
6
6
  RSpec::Core::RakeTask.new(:spec)
7
7
 
8
- require "rubocop/rake_task"
8
+ require 'rubocop/rake_task'
9
9
 
10
10
  RuboCop::RakeTask.new
11
11
 
data/bp3-hello-world.gemspec CHANGED
@@ -1,24 +1,24 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require_relative "lib/bp3/hello/world/version"
3
+ require_relative 'lib/bp3/hello/world/version'
4
4
 
5
5
  Gem::Specification.new do |spec|
6
- spec.name = "bp3-hello-world"
6
+ spec.name = 'bp3-hello-world'
7
7
  spec.version = Bp3::Hello::World::VERSION
8
- spec.authors = ["Wim den Braven"]
9
- spec.email = ["wimdenbraven@persuavis.com"]
8
+ spec.authors = ['Wim den Braven']
9
+ spec.email = ['wimdenbraven@persuavis.com']
10
10
 
11
- spec.summary = "Bp3::Hello::World is an example Bp3 plugin."
12
- spec.description = "Bp3::Hello::World is an example Bp3 plugin."
13
- spec.homepage = "https://www.black-phoebe.com"
14
- spec.license = "MIT"
15
- spec.required_ruby_version = ">= 3.2.2"
11
+ spec.summary = 'Bp3::Hello::World is an example BP3 plugin.'
12
+ spec.description = 'Bp3::Hello::World is an example BP3 plugin.'
13
+ spec.homepage = 'https://www.black-phoebe.com'
14
+ spec.license = 'MIT'
15
+ spec.required_ruby_version = '>= 3.2.2'
16
16
 
17
- spec.metadata["allowed_push_host"] = "https://rubygems.org"
17
+ spec.metadata['allowed_push_host'] = 'https://rubygems.org'
18
18
 
19
- spec.metadata["homepage_uri"] = spec.homepage
20
- spec.metadata["source_code_uri"] = "https://github.com/persuavis/bp3-hello-world"
21
- spec.metadata["changelog_uri"] = "https://github.com/persuavis/bp3-hello-world/blob/main/CHANGELOG.md"
19
+ spec.metadata['homepage_uri'] = spec.homepage
20
+ spec.metadata['source_code_uri'] = 'https://github.com/persuavis/bp3-hello-world'
21
+ spec.metadata['changelog_uri'] = 'https://github.com/persuavis/bp3-hello-world/blob/main/CHANGELOG.md'
22
22
 
23
23
  # Specify which files should be added to the gem when it is released.
24
24
  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,19 +27,19 @@ Gem::Specification.new do |spec|
27
27
  (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
28
28
  end
29
29
  end
30
- spec.bindir = "exe"
30
+ spec.bindir = 'exe'
31
31
  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
32
- spec.require_paths = ["lib"]
32
+ spec.require_paths = ['lib']
33
33
 
34
- spec.add_dependency "i18n", [">= 1.8.11", "< 2"]
34
+ spec.add_dependency 'i18n', ['>= 1.8.11', '< 2']
35
35
 
36
- spec.add_development_dependency "rake", "~> 13.0"
37
- spec.add_development_dependency "rspec", "~> 3.0"
38
- spec.add_development_dependency "rubocop", "~> 1.21"
39
- spec.add_development_dependency "rubocop-rake", "~> 0.6"
40
- spec.add_development_dependency "rubocop-rspec", "~> 2.25"
36
+ spec.add_development_dependency 'rake', '~> 13.0'
37
+ spec.add_development_dependency 'rspec', '~> 3.0'
38
+ spec.add_development_dependency 'rubocop', '~> 1.21'
39
+ spec.add_development_dependency 'rubocop-rake', '~> 0.6'
40
+ spec.add_development_dependency 'rubocop-rspec', '~> 2.25'
41
41
 
42
42
  # For more information and examples about making a new gem, check out our
43
43
  # guide at: https://bundler.io/guides/creating_gem.html
44
- spec.metadata["rubygems_mfa_required"] = "true"
44
+ spec.metadata['rubygems_mfa_required'] = 'true'
45
45
  end
data/lib/bp3/hello/world/context.rb CHANGED
@@ -6,7 +6,7 @@ module Bp3
6
6
  # Context says it all
7
7
  class Context
8
8
  def self.say_it!
9
- I18n.t("hello.world")
9
+ I18n.t('hello.world')
10
10
  end
11
11
 
12
12
  def say_it!
data/lib/bp3/hello/world/version.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  module Bp3
4
4
  module Hello
5
5
  module World
6
- VERSION = "0.1.3"
6
+ VERSION = '0.1.4'
7
7
  end
8
8
  end
9
9
  end
data/lib/bp3/hello/world.rb CHANGED
@@ -1,11 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require "i18n"
3
+ require 'i18n'
4
4
  load_dir = File.expand_path("#{File.dirname(__FILE__)}/../../../config/locales")
5
5
  I18n.load_path += Dir.glob("#{load_dir}/*.{rb,yml}")
6
6
 
7
- require_relative "world/context"
8
- require_relative "world/version"
7
+ require_relative 'world/context'
8
+ require_relative 'world/version'
9
9
 
10
10
  module Bp3
11
11
  module Hello
data/lib/bp3-hello-world.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require "bp3/hello/world"
3
+ require 'bp3/hello/world'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: bp3-hello-world
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Wim den Braven
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2023-11-06 00:00:00.000000000 Z
11
+ date: 2024-06-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: i18n
@@ -100,7 +100,7 @@ dependencies:
100
100
  - - "~>"
101
101
  - !ruby/object:Gem::Version
102
102
  version: '2.25'
103
- description: Bp3::Hello::World is an example Bp3 plugin.
103
+ description: Bp3::Hello::World is an example BP3 plugin.
104
104
  email:
105
105
  - wimdenbraven@persuavis.com
106
106
  executables: []
@@ -111,6 +111,7 @@ files:
111
111
  - ".rspec"
112
112
  - ".rubocop.yml"
113
113
  - ".ruby-version"
114
+ - ".yardopts"
114
115
  - CHANGELOG.md
115
116
  - Gemfile
116
117
  - Gemfile.lock
@@ -150,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
150
151
  - !ruby/object:Gem::Version
151
152
  version: '0'
152
153
  requirements: []
153
- rubygems_version: 3.4.21
154
+ rubygems_version: 3.5.11
154
155
  signing_key:
155
156
  specification_version: 4
156
- summary: Bp3::Hello::World is an example Bp3 plugin.
157
+ summary: Bp3::Hello::World is an example BP3 plugin.
157
158
  test_files: []