primrose 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bd154f7df76d53c3db2057c499b67edf417e621e0ff44c537382e9c78d946f6
+  data.tar.gz: b1c996a5c456ca5f0407189656d99352918812559139ab2a9b35a82b44ffbab3
+SHA512:
+  metadata.gz: dd085723441f9d29c8713a20f9bb3767771c0e26d3377e6c360bdd0407902446d88462a4940e73c984d09e4aa6718903d3d4fdeb2ccb392a91a6d4c31df3b444
+  data.tar.gz: f124f56efebe490b8cab7d368f3187ffcff27ce80fba1030579131eb2097c18108ea7a9448fdfbc618c99c50877bb5a7d92f78a65eae008edbf39dc03f385573

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Daniel M. Matongo
+
+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,136 @@
+# Primrose Framework Documentation
+
+## Overview
+
+Primrose is a Ruby library designed for building component-based web applications. It provides a collection of modules and classes to manage the state, routing, rendering, and event handling for a modern web application. Primrose offers the following key features:
+
+- State Management using `Primrose::Store`
+- Component-based UI building blocks via `Primrose::Rose` subclasses
+- Routing capabilities with `Primrose::Router`
+- Observable state via `Primrose::Observable`
+- Built-in helper methods and utility functions
+- Template-based rendering with ERB
+
+---
+
+## Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+    - [State Management](#state-management)
+    - [Routing](#routing)
+    - [Components](#components)
+    - [Event Handling](#event-handling)
+- [Examples](#examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Installation
+
+You can install the library by adding it to your `Gemfile`:
+
+```ruby
+gem 'primrose', '~> 0.0.1'
+```
+
+Then run `bundle install` to install the dependency.
+
+---
+
+## Usage
+
+### State Management
+
+```ruby
+store = Primrose::Store.new({ counter: 0 })
+
+store.dispatch({
+  type: 'INCREMENT',
+  updates: {
+    counter: -> (current_value) { current_value + 1 }
+  }
+})
+```
+
+### Routing
+
+```ruby
+router = Primrose::Router.new
+
+router.route('/home') { puts "You're at home" }
+router.route('/about') { puts "About page" }
+
+router.navigate('/home')  # Outputs "You're at home"
+```
+
+### Components
+
+Creating a custom component is easy:
+
+```ruby
+class MyComponent < Primrose::Rose
+  def render
+    "Hello, world!"
+  end
+end
+```
+
+### Event Handling
+
+You can attach event handlers to your components:
+
+```ruby
+component = MyComponent.new
+component.on(:click) { puts 'Component clicked!' }
+component.trigger(:click)  # Outputs "Component clicked!"
+```
+
+---
+
+## Examples
+
+Below are some example templates to showcase how components can be structured.
+
+- Button Component:
+
+  ```erb
+  <button onclick="<%= @action %>">
+    <%= @label %>
+  </button>
+  ```
+
+- Text Field Component:
+
+  ```erb
+  <input type="text" placeholder="<%= @placeholder %>">
+  ```
+
+- Checkbox Component:
+
+  ```erb
+  <div class="checkbox">
+    <input type="checkbox">
+    <label><%= @label %></label>
+  </div>
+  ```
+
+---
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+---
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
+
+---
+
+For more detailed usage and full API documentation, please refer to the inline code comments and accompanying documentation.
+
+Feel free to raise an issue for any bugs, feature requests, or questions.
+
+**Note**: This documentation assumes that you are familiar with Ruby and ERB (Embedded Ruby).

data/lib/primrose/components/button.rb

@@ -0,0 +1,28 @@
+require_relative '../prim'
+
+module Primrose
+  module Components
+    class Button < Rose
+      def initialize(label:, action:, style: nil, disabled: false, loading: false)
+        @label = label
+        @action = action
+        @style = style
+        @disabled = disabled
+        @loading = loading
+        super()
+      end
+
+      def render
+        Prim.render('templates/components/button.prim.erb', self)
+      end
+
+      def set_disabled(value)
+        @state.alter({ disabled: value })
+      end
+
+      def set_loading(value)
+        @state.alter({ loading: value })
+      end
+    end
+  end
+end

data/lib/primrose/components/checkbox.rb

@@ -0,0 +1,24 @@
+require_relative '../prim'
+
+module Primrose
+  module Components
+    class Checkbox < Rose
+      def initialize(label:, checked: false, id: nil, name: nil, js: nil)
+        @label = label
+        @checked = checked
+        @id = id || label.downcase.gsub(/\s+/, "_")  # Use label as id if id is not provided
+        @name = name || @id  # Use id as name if name is not provided
+        @js = js
+        super()
+      end
+
+      def render
+        Prim.render('templates/partials/_checkbox.prim.erb', self)
+      end
+
+      def set_checked(value)
+        @state.alter({ checked: value })
+      end
+    end
+  end
+end

data/lib/primrose/components/navbar.rb

@@ -0,0 +1,25 @@
+require_relative '../prim'
+
+module Primrose
+  module Components
+    class Navbar < Rose
+      def initialize(*args, links:, active_link: nil, sticky: false, brand: nil)
+        # puts "Non-keyword args: #{args.inspect}"
+        # puts "Initializing Navbar with #{links.inspect}, #{active_link}, #{sticky}, #{brand}"
+        @links = links
+        @active_link = active_link
+        @sticky = sticky
+        @brand = brand
+        super()
+      end
+
+      def render
+        Prim.render('templates/components/navbar.prim.erb', self)
+      end
+
+      def set_active_link(new_active_link)
+        @state.alter({ active_link: new_active_link })
+      end
+    end
+  end
+end

data/lib/primrose/components/text_field.rb

@@ -0,0 +1,23 @@
+require_relative '../prim'
+
+module Primrose
+  module Components
+    class TextField < Rose
+      def initialize(placeholder:, name: nil, label: nil, min_length: nil, max_length: nil, read_only: false, default_value: nil, style_class: nil)
+        @placeholder = placeholder
+        @name = name
+        @label = label
+        @min_length = min_length
+        @max_length = max_length
+        @read_only = read_only
+        @default_value = default_value
+        @style_class = style_class
+        super()
+      end
+
+      def render
+        Prim.render('templates/components/text_field.prim.erb', self)
+      end
+    end
+  end
+end

data/lib/primrose/helpers.rb

@@ -0,0 +1,39 @@
+require_relative 'components/button'
+require_relative 'components/navbar'
+require_relative 'components/text_field'
+require_relative 'components/checkbox'
+
+module Primrose
+  module Helpers
+    # Load a component dynamically based on the name
+    def component(name, **args, &block)
+      klass = Object.const_get("Primrose::Components::#{name}")
+      begin
+        instance = klass.new(**args)
+      rescue ArgumentError => e
+        puts "Error while initializing #{klass}: #{e.message}"
+        puts "Backtrace: #{e.backtrace.join("\n")}"
+        raise e
+      end
+      block&.call(instance)
+      instance.render
+    end
+
+    # Specific helpers
+    def button(label:, action:, **opts)
+      component('Button', label: label, action: action, **opts)
+    end
+
+    def navbar(links:, **opts)
+      component('Navbar', links: links, **opts)
+    end
+
+    def text_field(placeholder:, **opts)
+      component('TextField', placeholder: placeholder, **opts)
+    end
+
+    def checkbox(label:, checked: false, **opts)
+      component('Checkbox', label: label, checked: checked, **opts)
+    end
+  end
+end

data/lib/primrose/observable.rb

@@ -0,0 +1,59 @@
+require_relative 'utils/deep_clone'
+
+module Primrose
+  class Observable
+    def initialize(value)
+      @value = value
+      @listeners = []
+      @previous_value = deep_clone(value)
+      @events = {}
+    end
+
+    def follow(&block)
+      @listeners << block
+      block.call(@value, @previous_value)
+    end
+
+    def on(event_name, &block)
+      (@events[event_name] ||= []) << block
+    end
+
+    def trigger(event_name, *args)
+      (@events[event_name] || []).each do |listener|
+        listener.call(*args)
+      end
+    end
+
+    # State Persistence
+    def save_state(key)
+      File.write("#{key}.json", @value.to_json)
+    end
+
+    def load_state(key)
+      if File.exist?("#{key}.json")
+        @value = JSON.parse(File.read("#{key}.json"))
+        notify_observers
+      end
+    end
+
+    def alter(new_value)
+      @previous_value = deep_clone(@value)
+      @value = new_value
+      notify_observers
+    end
+
+    def value
+      @value
+    end
+
+    private
+
+    def deep_clone(object)
+      Primrose::Utils.deep_clone(object)
+    end
+
+    def notify_observers
+      @listeners.each { |listener| listener.call(@value, @previous_value) }
+    end
+  end
+end

data/lib/primrose/prim.rb

@@ -0,0 +1,30 @@
+require 'erb'
+require 'logger'
+
+module Primrose
+  class Prim
+    @template_cache = {}
+    @logger = Logger.new(STDOUT)
+
+    def self.render(template_path, context)
+      template = read_template(template_path)
+      erb = ERB.new(template)
+      rendered = erb.result(context.get_binding)
+
+      # replace partial tags with actual content
+      rendered.gsub(/<%= partial "(.*?)" %>/) do
+        partial_path = File.join('templates/partials', "#{$1}.prim.erb")
+        render(partial_path, context)
+      end
+    end
+
+    private
+
+    def self.read_template(template_path)
+      @template_cache[template_path] ||= File.read(template_path)
+    rescue => e
+      @logger.error("Could not read template: #{e.message}")
+      raise
+    end
+  end
+end

data/lib/primrose/rose.rb

@@ -0,0 +1,90 @@
+module Primrose
+  class Rose
+    attr_reader :state, :event_handlers, :children
+
+    def initialize
+      @state = Observable.new({})
+      @event_handlers = {}
+      @children = []
+      lifecycle(:initialize)
+    end
+
+    def lifecycle(method)
+      send(method) if respond_to?(method)
+    end
+
+    def render
+      begin
+        lifecycle(:before_render)
+        lifecycle(:after_render)
+      rescue StandardError => e
+        handle_error(e)
+      end
+    end
+
+    def on(event, &block)
+      @event_handlers[event] ||= []
+      @event_handlers[event] << block
+    end
+
+    def trigger(event, *args)
+      return unless @event_handlers[event]
+
+      @event_handlers[event].each do |handler|
+        handler.call(*args)
+      end
+    end
+
+    def add_child(child)
+      @children << child
+    end
+
+    def render_children
+      @children.map { |child| child.render }.join("\n")
+    end
+
+    # Error Handling
+    def handle_error(error)
+      puts "An error occurred: #{error.message}"
+      # Log to a file or send to monitoring service
+      # You can add more specific logic here based on the type of error
+      error.backtrace.each { |line| puts line }
+    end
+
+    # Setup Hook
+    def setup
+      # Placeholder for logic to run only once during the object's lifetime,
+      # prior to the `initialize` lifecycle method
+    end
+
+    # Additional Lifecycle Hooks
+    def before_mount
+      # Placeholder for logic to run before the component is added to the DOM
+    end
+
+    def after_mount
+      # Placeholder for logic to run after the component is added to the DOM
+    end
+
+    def before_unmount
+      # Placeholder for logic to run before the component is removed from the DOM
+    end
+
+    def after_unmount
+      # Placeholder for logic to run after the component is removed from the DOM
+    end
+
+    # Existing hooks
+    def before_render
+      # Placeholder for logic to run immediately before the render method
+    end
+
+    def after_render
+      # Placeholder for logic to run immediately after the render method
+    end
+
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/primrose/router.rb

@@ -0,0 +1,17 @@
+module Primrose
+  class Router
+    def initialize
+      @routes = {}
+    end
+
+    def route(path, &block)
+      @routes[path] = block
+    end
+
+    def navigate(path)
+      return unless @routes[path]
+
+      @routes[path].call
+    end
+  end
+end

data/lib/primrose/store.rb

@@ -0,0 +1,23 @@
+module Primrose
+  class Store
+    attr_reader :state
+
+    def initialize(initial_state = {})
+      @state = Observable.new(initial_state)
+    end
+
+    def dispatch(action)
+      new_state = @state.value.dup  # Start with a copy of the current state
+      puts "Dispatching action: #{action[:type]}"
+
+      action[:updates].each do |key, value|
+        puts "Updating #{key} with #{value}"
+        new_state[key] = value.call(new_state[key])  # Apply update function to corresponding value in state
+        puts "New value: #{new_state[key]}"
+      end
+
+      @state.alter(new_state)  # Update state
+      puts "New state: #{@state}"
+    end
+  end
+end

data/lib/primrose/utils/deep_clone.rb

@@ -0,0 +1,7 @@
+module Primrose
+  module Utils
+    def self.deep_clone(object)
+      Marshal.load(Marshal.dump(object))
+    end
+  end
+end

data/lib/primrose/version.rb

@@ -0,0 +1,3 @@
+module Primrose
+  VERSION = "0.0.1"
+end

data/lib/primrose.rb

@@ -0,0 +1,7 @@
+require_relative 'primrose/version'
+require_relative 'primrose/observable'
+require_relative 'primrose/rose'
+require_relative 'primrose/store'
+require_relative 'primrose/router'
+require_relative 'primrose/prim'
+require_relative 'primrose/helpers'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: primrose
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel M. Matongo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A gem for observable data structures and components
+email: mmatongo_@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/primrose.rb
+- lib/primrose/components/button.rb
+- lib/primrose/components/checkbox.rb
+- lib/primrose/components/navbar.rb
+- lib/primrose/components/text_field.rb
+- lib/primrose/helpers.rb
+- lib/primrose/observable.rb
+- lib/primrose/prim.rb
+- lib/primrose/rose.rb
+- lib/primrose/router.rb
+- lib/primrose/store.rb
+- lib/primrose/utils/deep_clone.rb
+- lib/primrose/version.rb
+homepage: https://github.com/mmatongo/primrose.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: A gem for observable data structures and components
+test_files: []