rbminivents 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 516cebd771ef42bc0233d276a1e9d7cafd2f129b70e6f96c6a1e124537a200a8
+  data.tar.gz: ab39feb59826b236c658261550d3d026abab22f2cd608130fac42f626a83e9fa
+SHA512:
+  metadata.gz: f88f86014ab9421eea8f98a5af2d385bd3e6927b119de5b22067c73b66359058e932bffb45b5caf20563fab042aef56253c271637bd8c268c2b9f16833b388d2
+  data.tar.gz: c3ca2963c64c069b89efa6c2b10f0425184276f3c314a04d95d7e6988474f8654dc8e62d441ec9f7aaabf064c2183564db61add707cfc2f8680c7231f4576753

data/.github/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Don't forget to add specs and make sure they pass by running `rspec .`.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you.
+6. If necessary, add documentation for your feature or bug fix.
+7. Commit and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches
+[pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request. Were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here.

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.1 (12-Apr-21)
+
+* Main functionality implemented
+
+
+## 0.1.0 (12-Apr-21)
+
+* Initial (proper) release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Maxim Barsukov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# rbminivents
+This gem allows you to create and emit your events very easily and minimalistic.
+
+## Description
+This gem was made under the influence of the tiny JS library [minivents](https://github.com/allouis/minivents) by [allouis](https://github.com/allouis) that I liked. It seemed to me that it would be nice to transfer this to Ruby.
+
+## Getting started
+
+### Requirements
+
+This gem requires Ruby 2.5+. It might work with older versions of Rails though.
+
+### Installation
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem 'rbminivents'
+```
+
+and run:
+
+```
+bundle install
+```
+
+## API
+This project is similar to the original one in many ways, but some features are not implemented
+So,
+
+`on`: Listen to event
+
+`off`: Stop listening to event
+
+`emit`: Emit event
+
+
+## Examples
+### Standard way
+```ruby
+require 'rbminivents'
+
+sandbox = RbMinivents::Events.new
+
+sandbox.on(:event) do
+  # do stuff
+end
+
+sandbox.emit(:event)  # does stuff
+
+sandbox.off(:event)
+
+sandbox.emit(:event)  # does not do stuff
+```
+
+### Passing parameters
+```ruby
+require 'rbminivents'
+
+sandbox = RbMinivents::Events.new
+
+sandbox.on(:event) do |name|
+  puts "Hello, #{name}!"
+end
+
+sandbox.emit(:event, 'Max')  #=> Hello, Max!
+# OR
+# when there are > 1 arguments, pass them through the array
+sandbox.emit(:event, ['Max'])  #=> Hello, Max!
+```
+
+```ruby
+require 'rbminivents'
+
+sandbox = RbMinivents::Events.new
+
+sandbox.on(:event) do |hash, arr, num, bool|
+  puts hash[:name]
+  p arr
+  puts "5 + #{num} = #{5 + num}"
+  puts "It's true!" if bool
+end
+
+# max, [1, 2, 3], 5 + 7 = 12
+sandbox.emit(:event,
+             [ 
+               {name: 'max'},
+               [1, 2, 3],
+               7,
+               false
+             ]
+)
+```

data/lib/rbminivents.rb

@@ -0,0 +1,39 @@
+module RbMinivents
+  class Events
+
+    def initialize
+      @events = Hash.new
+    end
+
+    # On: listen to events
+    def on(type, &prc)
+      sym = type.to_s.to_sym
+
+      @events[sym] = prc if block_given?
+      self
+    end
+
+    # Off: stop listening to event
+    def off(type)
+      sym = type.to_s.to_sym
+
+      if @events.has_key?(sym)
+        @events.delete(sym)
+      end
+
+      self
+    end
+
+    # Emit: send event, callbacks will be triggered
+    def emit(type, args = nil)
+      sym = type.to_s.to_sym
+
+      if @events.has_key?(sym)
+        @events[sym].call(*args)
+        @events.delete(sym)
+      end
+
+      self
+    end
+  end
+end

data/lib/rbminivents/version.rb

@@ -0,0 +1,3 @@
+module RbMinivents
+  VERSION = '0.1.1'
+end

data/rbminivents.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path('lib/rbminivents/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'rbminivents'
+  spec.version               = RbMinivents::VERSION
+  spec.authors               = ['Max Barsukov']
+  spec.email                 = ['maximb2208@gmail.com']
+  spec.summary               = 'Tiny eventing gem'
+  spec.description           = 'This gem allows you to create and emit your events very easily and minimalistic.'
+  spec.homepage              = 'https://github.com/maxbarsukov/rbminivents'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.files = Dir['README.md', 'LICENSE',
+                   'CHANGELOG.md', 'lib/**/*.rb',
+                   'lib/**/*.rake',
+                   'rbminivents.gemspec', '.github/*.md',
+                   'Gemfile', 'Rakefile']
+
+  spec.test_files       = Dir['spec/**/*.rb']
+  spec.extra_rdoc_files = ['README.md']
+  spec.require_paths    = ['lib']
+
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.2.0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rbminivents
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Max Barsukov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: This gem allows you to create and emit your events very easily and minimalistic.
+email:
+- maximb2208@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/CONTRIBUTING.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/rbminivents.rb
+- lib/rbminivents/version.rb
+- rbminivents.gemspec
+homepage: https://github.com/maxbarsukov/rbminivents
+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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key: 
+specification_version: 4
+summary: Tiny eventing gem
+test_files: []