peeky 0.0.14

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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 28af40c7ccec4e9da59512a6fbac9a111768d5466c17a9a0fc0003928fa59191
4
+ data.tar.gz: '087aefb7db2766131766ab7cc9346449896cbec13ec14a583f96b3971da29df8'
5
+ SHA512:
6
+ metadata.gz: 6fd1164f74cd0f4b39a60b758372d771105147bd95e5032731d74c398862b60f748ea1b9b12ce4a92ff0857a0ae3d635db88781ce5390bc222156ca3625ed73e
7
+ data.tar.gz: 2c89b203b742301aa4834077bf56d60b6a412a753cff3d3c223dd2a86fb6a95d68aeff05f770d0b977760c94a6afea47f83fdd922796d6bb25046666a384a4ea
@@ -0,0 +1,46 @@
1
+ # Move this into a KLUE SATELITE DOCUMENT
2
+ # See https://help.github.com/articles/ignoring-files for more about ignoring files.
3
+ #
4
+ # If you find yourself ignoring temporary files generated by your text editor
5
+ # or operating system, you probably want to add a global ignore instead:
6
+ # git config --global core.excludesfile '~/.gitignore_global'
7
+ #
8
+ # The Octocat has a Gist containing some good rules to add to this file.
9
+ # https://gist.github.com/octocat/9257657
10
+
11
+ # Ignore Klue Setup.sh
12
+ /bin/runonce/
13
+ peeky.yml
14
+ /_
15
+ /.bundle/
16
+ /.history/
17
+ /.yardoc
18
+ /_yardoc/
19
+ /coverage/
20
+ /log/
21
+ !/log/.keep
22
+ /doc/
23
+ /pkg/
24
+ /spec/reports/
25
+ /tmp/
26
+ !/tmp/.keep
27
+ *.bundle
28
+ *.so
29
+ *.o
30
+ *.a
31
+ mkmf.log
32
+
33
+ # Ruby Version
34
+ .ruby-version
35
+
36
+ # Environment File
37
+ .env
38
+
39
+ # Gems should not use a Gemfile.lock
40
+ Gemfile.lock
41
+
42
+ # rspec failure tracking
43
+ .rspec_status
44
+
45
+ # ByeBug history
46
+ .byebug_history
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,57 @@
1
+ AllCops:
2
+ DisplayCopNames: true
3
+ ExtraDetails: true
4
+ NewCops: enable
5
+ Exclude:
6
+ - "_/**/*"
7
+
8
+ # My Preferences - Start
9
+ Style/AccessorGrouping:
10
+ Enabled: false
11
+
12
+ Layout/SpaceBeforeComma:
13
+ Enabled: false
14
+ # My Preferences - End
15
+
16
+ Metrics/BlockLength:
17
+ Exclude:
18
+ - "**/spec/*"
19
+ ExcludedMethods:
20
+ - configure
21
+ - context
22
+ - define
23
+ - describe
24
+ - draw
25
+ - factory
26
+ - feature
27
+ - guard
28
+ - included
29
+ - it
30
+ - let
31
+ - let!
32
+ - scenario
33
+ - setup
34
+ - shared_context
35
+ - shared_examples
36
+ - shared_examples_for
37
+ - transaction
38
+
39
+ Metrics/MethodLength:
40
+ Max: 25
41
+
42
+ Layout/LineLength:
43
+ Max: 200
44
+ # Ignores annotate output
45
+ IgnoredPatterns: ['\A# \*\*']
46
+ IgnoreCopDirectives: true
47
+
48
+ Lint/UnusedMethodArgument:
49
+ AllowUnusedKeywordArguments: true
50
+
51
+ Style/BlockComments:
52
+ Enabled: false
53
+ Include:
54
+ - "**/spec/*"
55
+
56
+ inherit_from: .rubocop_todo.yml
57
+
@@ -0,0 +1,54 @@
1
+ # This configuration was generated by
2
+ # `rubocop --auto-gen-config`
3
+ # on 2020-11-01 08:10:24 UTC using RuboCop version 0.89.0.
4
+ # The point is for the user to remove these configuration records
5
+ # one by one as the offenses are removed from the code base.
6
+ # Note that changes in the inspected code, or installation of new
7
+ # versions of RuboCop, may require this file to be generated again.
8
+
9
+ # Offense count: 1
10
+ # Cop supports --auto-correct.
11
+ # Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
12
+ # Include: **/*.gemfile, **/Gemfile, **/gems.rb
13
+ Bundler/OrderedGems:
14
+ Exclude:
15
+ - 'Gemfile'
16
+
17
+ # Offense count: 1
18
+ # Configuration parameters: Include.
19
+ # Include: **/*.gemspec
20
+ Gemspec/RequiredRubyVersion:
21
+ Exclude:
22
+ - 'peeky.gemspec'
23
+
24
+ # Offense count: 1
25
+ # Cop supports --auto-correct.
26
+ # Configuration parameters: EnforcedStyle.
27
+ # SupportedStyles: always, always_true, never
28
+ Style/FrozenStringLiteralComment:
29
+ Exclude:
30
+ - 'lib/peeky/version.rb'
31
+
32
+ # Offense count: 1
33
+ # Cop supports --auto-correct.
34
+ # Configuration parameters: EnforcedStyle.
35
+ # SupportedStyles: literals, strict
36
+ Style/MutableConstant:
37
+ Exclude:
38
+ - 'lib/peeky/version.rb'
39
+
40
+ # Offense count: 1
41
+ # Cop supports --auto-correct.
42
+ # Configuration parameters: EnforcedStyle, AllowInnerSlashes.
43
+ # SupportedStyles: slashes, percent_r, mixed
44
+ Style/RegexpLiteral:
45
+ Exclude:
46
+ - 'Guardfile'
47
+
48
+ # Offense count: 1
49
+ # Cop supports --auto-correct.
50
+ # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
51
+ # SupportedStyles: single_quotes, double_quotes
52
+ Style/StringLiterals:
53
+ Exclude:
54
+ - 'lib/peeky/version.rb'
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ - Using welcoming and inclusive language
18
+ - Being respectful of differing viewpoints and experiences
19
+ - Gracefully accepting constructive criticism
20
+ - Focusing on what is best for the community
21
+ - Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ - The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ - Trolling, insulting/derogatory comments, and personal or political attacks
28
+ - Public or private harassment
29
+ - Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ - Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at david.cruwys@bugcrowd.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ # Specify your gem's dependencies in poc_github_ap.gemspec
6
+ gemspec
7
+
8
+ group :development, :test do
9
+ gem 'guard-bundler'
10
+ gem 'guard-rspec'
11
+ gem 'guard-rubocop'
12
+ # pry on steroids
13
+ gem 'pry-coolline', github: 'owst/pry-coolline', branch: 'support_new_pry_config_api'
14
+ gem 'jazz_fingers'
15
+ gem 'rake', '~> 12.0'
16
+ # this is used for cmdlets 'self-executing gems'
17
+ gem 'rake-compiler'
18
+ gem 'rspec', '~> 3.0'
19
+ gem 'rubocop'
20
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ guard :bundler, cmd: 'bundle install' do
4
+ watch('Gemfile')
5
+ watch('peeky.gemspec')
6
+ end
7
+
8
+ group :green_pass_then_cop, halt_on_fail: true do
9
+ guard :rspec, cmd: 'bundle exec rspec -f doc' do
10
+ require 'guard/rspec/dsl'
11
+ dsl = Guard::RSpec::Dsl.new(self)
12
+
13
+ # RSpec files
14
+ rspec = dsl.rspec
15
+ watch(rspec.spec_helper) { rspec.spec_dir }
16
+ watch(rspec.spec_support) { rspec.spec_dir }
17
+ watch(rspec.spec_files)
18
+
19
+ # Ruby files
20
+ ruby = dsl.ruby
21
+ dsl.watch_spec_files_for(ruby.lib_files)
22
+ watch(%r{^lib/peeky/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
23
+ watch(%r{^lib/peeky/commands/(.+)\.rb$}) { |m| "spec/unit/commands/#{m[1]}_spec.rb" }
24
+ end
25
+
26
+ guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
27
+ watch(%r{.+\.rb$})
28
+ watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
29
+ end
30
+ end
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 David
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,85 @@
1
+ # ToDo
2
+
3
+ * Manually create each file using the template system
4
+ - Models
5
+ - [Done] ParameterInfo
6
+ - [Done] AttrInfo
7
+ - [Done] ClassInfo
8
+ - [Done] MethodInfo
9
+ - Create predicates
10
+ - [Done] attr_reader_predicate
11
+ - [Done] attr_writer_predicate
12
+ - Create renderers
13
+ - [Done] method_call_minimum_params_render
14
+ - [Done] method_signature_render
15
+ - [Done] method_signature_with_debug_render
16
+ - [Done] class_interface_render
17
+ - [Done] Recreate peeky
18
+ - [Done] Symlink KlueLess files
19
+ - [Done] Hot fix after each section
20
+ - [Done] Make sure the klueless files follow a natural structure
21
+ - [Done] Push peeky to Ruby Gems
22
+ - Build out the readme file
23
+ - Build out the stories
24
+ - Back compare templates vis definitions
25
+ - Auto create .template folder with copied definitions
26
+
27
+
28
+ # Peeky
29
+
30
+ > Peeky is a Ruby GEM for peaking into ruby classes and extracting meta
31
+
32
+ Welcome to your new ruby gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/peeky`.
33
+
34
+ When using the source code for this gem, start by running `bin/setup` to install locally or `bundle install`
35
+
36
+ To experiment with that code, run `bin/console` for an interactive prompt or run `exe/peeky` to see a list of commands.
37
+
38
+ ## Installation
39
+
40
+ Add this line to your application's Gemfile:
41
+
42
+ ```ruby
43
+ gem 'peeky'
44
+ ```
45
+
46
+ And then execute:
47
+
48
+ ```bash
49
+ bundle install
50
+ ```
51
+
52
+ Or install it yourself as:
53
+
54
+ ```bash
55
+ gem install peeky
56
+ ```
57
+
58
+ ## Stories
59
+
60
+
61
+ ## Usage
62
+
63
+ TODO: Write usage instructions here
64
+
65
+ ## Development
66
+
67
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
68
+
69
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
70
+
71
+ ## Contributing
72
+
73
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/peeky. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
74
+
75
+ ## License
76
+
77
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
78
+
79
+ ## Code of Conduct
80
+
81
+ Everyone interacting in the Peeky project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/peeky/blob/master/CODE_OF_CONDUCT.md).
82
+
83
+ ## Copyright
84
+
85
+ Copyright (c) David. See [MIT License](LICENSE.txt) for further details.
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'bundler/gem_tasks'
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require 'rake/extensiontask'
9
+
10
+ task build: :compile
11
+
12
+ Rake::ExtensionTask.new('peeky') do |ext|
13
+ ext.lib_dir = 'lib/peeky'
14
+ end
15
+
16
+ task default: %i[clobber compile spec]
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ # frozen_string_literal: true
4
+
5
+ require 'bundler/setup'
6
+ require 'peeky'
7
+
8
+ # You can add fixtures and/or initialization code here to make experimenting
9
+ # with your gem easier. You can also use a different console, if you like.
10
+
11
+ # (If you use this, don't forget to add pry to your Gemfile!)
12
+ # require 'pry'
13
+ # Pry.start
14
+
15
+ require 'irb'
16
+ IRB.start(__FILE__)
data/bin/k ADDED
@@ -0,0 +1,36 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ # NOTE: you may need change file permissions
5
+ # chmod +x bin/k
6
+
7
+ help = %(
8
+ ----------------------------------------------------------------------
9
+ Klue Scripts - Help
10
+ ----------------------------------------------------------------------
11
+ k - This Help File
12
+
13
+ khotfix - Create Hot Fix
14
+ Hot fixes are created in GIT and versioned correctly.
15
+ The patch # will increment by 1.
16
+ e.g. v0.1.1 will become v0.1.2
17
+ The version.rb file will also store the current version.
18
+ usage:
19
+ khotfix 'name of my cool hotfix'
20
+
21
+ kgitsync - Synchronize the master and development git repositories
22
+ Pulls latest code, pushes current changes
23
+ usage:
24
+ kgitsync
25
+
26
+ ----------------------------------------------------------------------
27
+ Rake Tasks
28
+ ----------------------------------------------------------------------
29
+
30
+ rails db:seed - load seed data
31
+
32
+ rails db:seed sample=true - load sample data, useful in developer environments
33
+
34
+ rails db:seed reset=true - reset database
35
+ )
36
+ puts help