ikibana 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 159f0b53cd7206dff8ab920b5c568a60a05c569278b8c2e0242b099196da4545
+  data.tar.gz: 44c22b18228c278a12f5e1612f98d5d8274f4421a9daf6bb63b42a2f2779a206
+SHA512:
+  metadata.gz: bf3822dad6c13583cc4acdd700f73cfc31e0bc3609f00829ab6e0121e6c0eb35997e14ee5611a95ca570048802792ff14395733e590e9d1bb0b5bb921848a1aa
+  data.tar.gz: bae1f4c53108edda9554f63beb1a3d74333a50af08ccd2f3dc9671c56f5c9b9512de8abea1d5b0ece490aee8f106b966c62abe6955b80c85d1b246700d96dc4e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Aram
+
+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,43 @@
+# Ikibana
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new 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/ikibana`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ikibana. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ikibana/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ikibana project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ikibana/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/ikibana

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "ikibana"
+
+puts "Hello, world!"

data/lib/generators/ikibana/consumer/consumer_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ikibana
+  class ConsumerGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../../templates", __dir__)
+
+    def create_worker
+      template "consumer.rb.erb", File.join("app/ikibana", class_path, "#{file_name}_consumer.rb")
+    end
+
+    def create_worker_spec
+      template "consumer_spec.rb.erb", File.join("spec/ikibana", class_path, "#{file_name}_consumer_spec.rb")
+    end
+  end
+end

data/lib/generators/ikibana/install/install_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ikibana
+  module Generators
+    # This class is responsible for creating the initial files in your app folder
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __dir__)
+
+      def create_directories
+        empty_directory "app/ikibana"
+        create_file "app/ikibana/.keep"
+        empty_directory "spec/ikibana"
+        create_file "spec/ikibana/.keep"
+        template "nats.yaml.erb", "config/nats.yaml"
+        template "configure.rb.erb", "config/initializers/ikibana.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/configure.rb.erb

@@ -0,0 +1,5 @@
+require 'ikibana/config'
+
+Ikibana::Config.configure do |cfg|
+  # cfg.logger = Logger.new("log/ikibana.log") or Rails.logger
+end

data/lib/generators/templates/consumer.rb.erb

@@ -0,0 +1,8 @@
+#frozen_string_literal: true
+
+class <%= class_name %>Consumer < Ikibana::ApplicationConsumer
+  private
+  def perform(msg)
+    # Do something
+  end
+end

data/lib/generators/templates/consumer_spec.rb.erb

@@ -0,0 +1,6 @@
+#frozen_string_literal: true
+
+Rspec.describe <%= class_name %>Consumer, type: :consumer do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+

data/lib/generators/templates/nats.yaml.erb

@@ -0,0 +1,8 @@
+connection:
+  url: <%%= ENV.fetch('NATS_URL', 'nats://localhost:4222') %>
+streams: []
+  # Here you define your streams and their subjects
+  # https://docs.nats.io/nats-concepts/jetstream/streams all the possible keys to the elements are described here
+#  - name: 'EXAMPLE'
+#    subjects: ['example.*', 'example.a.*']
+#    max_age: 100 * 1000000 # which is 100ms

data/lib/ikibana/application_consumer.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "consumer"
+
+module Ikibana
+  class ApplicationConsumer
+    private_class_method def self.inherited(subclass)
+      subclass.include Ikibana::Consumer
+    end
+
+    def initialize
+      super
+      ObjectSpace.define_finalizer(self, self.class.method(:destructor).to_proc)
+    end
+
+    def self.call
+      new.call
+    end
+
+    def call
+      return if locked?
+      return run_in_sync if sync?
+
+      run_async
+    end
+
+    private
+
+    def run_async
+      Thread.new do
+        loop do
+          sub.fetch(1).each do |msg|
+            perform(msg)
+            msg.ack
+          end
+        rescue NATS::IO::Timeout
+          puts "Awaiting messages for #{convert_namespace_to_path}..."
+        end
+      end
+    end
+
+    def run_in_sync
+      # code here
+    end
+
+    def sub
+      @sub ||= js.pull_subscribe(convert_namespace_to_path, self.class.to_s.sub("::", "_"))
+    end
+
+    def convert_namespace_to_path
+      self.class.to_s.split("::").map(&:downcase).join(".").sub("consumer", "")
+    end
+
+    def logger
+      @logger = Ikibana::Config.instance.logger
+    end
+
+    def js
+      @js ||= Ikibana::Config.instance.js
+    end
+
+    def locked? = cache.read("#{self.class}_locked")
+
+    def sync? = cache.read("#{self.class}_sync")
+
+    def cache
+      @cache = Ikibana::Config.instance.cache
+    end
+
+    def perform(msg)
+      raise NotImplementedError, "Subclasses must implement a `perform` method"
+    end
+  end
+end

data/lib/ikibana/config.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "erb"
+require "singleton"
+require "nats/client"
+
+module Ikibana
+  class ICache
+    def write(...) = raise NotImplementedError, "Subclasses must implement a `write` method"
+    def read(...) = raise NotImplementedError, "Subclasses must implement a `read` method"
+  end
+
+  # Configuration class for NATS
+  class Config
+    include Singleton
+
+    attr_reader :config, :connection_string, :nats, :js
+    attr_accessor :logger, :consumers, :cache
+
+    def initialize(config_file = "config/nats.yaml")
+      @config = load_config(config_file)
+      @connection_string = @config["connection"]["url"]
+      @logger = Logger.new($stdout)
+      connect
+      create_streams
+    rescue NATS::IO::Timeout
+      @logger.error("NATS server not responding")
+    rescue StandardError => e
+      @logger.error("#{e.class}: Error connecting to NATS server: #{e.message}")
+    end
+
+    def self.configure(config_file = "config/nats.yaml")
+      yield instance if block_given?
+    end
+
+    private
+
+    def create_streams
+      @config["streams"].each do |stream|
+        @js.add_stream(**stream.transform_keys(&:to_sym))
+      end
+    end
+
+    def connect
+      @nats ||= NATS.connect(@connection_string)
+      @js ||= @nats.jetstream
+      @logger.debug("Connected to NATS server at #{nats_host}")
+    end
+
+    def nats_host
+      @nats_host ||= URI.parse(@connection_string).host
+    end
+
+    def load_config(file)
+      raise "Configuration file #{file} not found" unless File.exist?(file)
+
+      erb = ERB.new(File.read(file))
+      YAML.safe_load(erb.result, aliases: true)
+    rescue Psych::SyntaxError => e
+      raise "YAML syntax error occurred while parsing #{file}: #{e.message}"
+    end
+  end
+end

data/lib/ikibana/consumer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Ikibana
+  module Consumer
+    def self.included(mod)
+      mod.extend self
+      mod.extend ClassMethods
+      mod.include ClassMethods
+    end
+
+    module ClassMethods
+      def at_most_once
+        cache.write("#{self}_locked", true)
+      end
+
+      def sync(...)
+        cache.write("#{self}_locked", false)
+        cache.write("#{self}_sync", true)
+      end
+
+      def destructor(...)
+        cache.write("#{self}_locked", false)
+      end
+
+      def cache
+        Ikibana::Config.instance.cache
+      end
+    end
+  end
+end

data/lib/ikibana/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module Ikibana
+  # This class is a Railtie that allows the gem to be used in a Rails application.
+  class Railtie < Rails::Railtie
+    railtie_name :active_transaction
+
+    rake_tasks do
+      load "tasks/ikibana_tasks.rake"
+    end
+  end
+end

data/lib/ikibana/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ikibana
+  VERSION = "0.1.0"
+end

data/lib/ikibana.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "ikibana/version"
+require_relative "ikibana/application_consumer"
+require_relative "ikibana/railtie" if defined?(Rails)
+
+module Ikibana
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/tasks/ikibana_tasks.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :active_transaction do
+  desc "version"
+  task :version do
+    puts "Ikibana version: #{ActiveTransaction::VERSION}"
+  end
+end

data/sig/ikibana.rbs

@@ -0,0 +1,4 @@
+module Ikibana
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: ikibana
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aram
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nats-pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Ikibana is a Rails integration with NATS
+  It provides a way to use NATS in Rails applications using Rails jobs as producers and workers as consumers.
+email:
+- aramhrptn@hotmail.com
+executables:
+- ikibana
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/ikibana
+- lib/generators/ikibana/consumer/consumer_generator.rb
+- lib/generators/ikibana/install/install_generator.rb
+- lib/generators/templates/configure.rb.erb
+- lib/generators/templates/consumer.rb.erb
+- lib/generators/templates/consumer_spec.rb.erb
+- lib/generators/templates/nats.yaml.erb
+- lib/ikibana.rb
+- lib/ikibana/application_consumer.rb
+- lib/ikibana/config.rb
+- lib/ikibana/consumer.rb
+- lib/ikibana/railtie.rb
+- lib/ikibana/version.rb
+- lib/tasks/ikibana_tasks.rake
+- sig/ikibana.rbs
+homepage: https://github.com/svck-dev/ikibana
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/svck-dev/ikibana
+  source_code_uri: https://github.com/svck-dev/ikibana
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Ikibana is a Rails integration with NATS
+test_files: []