hud 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 981ad846d567a7da913deebbb36363e47c3f94579dacc703d8d8d00da5f5de66
-  data.tar.gz: a76d26c75db75c39a2359459b63f6cdcb4ad504fb24194302f698805fe244cd5
+  metadata.gz: 7767c2ce73d0eeb9d5e916571d5c803dc7284ac205164620f078a94d15ecf858
+  data.tar.gz: d403a001da10478068dc7922d159b71f502be463adaf0444509a14909350f731
 SHA512:
-  metadata.gz: 277faeb313a3d49110c33d2f23360fdef01940cd9a6245c15f69d869aea0c7a6c2b33957fbe312f9693a2c464c17f9bb980c785f58d273d12a5fbf3530a3ba90
-  data.tar.gz: 7d7cbfe516f95a25d0459ce4361e6973da951ac770e649cb6cbd54399665d6f176044886d44d47bde5ae1b6ed177d9a543ddc8683a9a3404cfba2b3674fcd119
+  metadata.gz: 59117db5b855661d38e5913ef565a6e013e61ff41fca4e03a1ea3ffbe5b09f50ca5d95638973efecbba06413ee794f7dcc00bc9f3fbc90cdb396ffd5a585e912
+  data.tar.gz: 42d46949e940a5bbf360459412f5455cf44c5c1965df5392202ee80f40161d5de2bbe06cf78e42a35b5cbdfac4d537b1b1d416dff0e3ff6f5ab8b2794135a2d4

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at delaney@vidtreone.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Delaney Burke
+
+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,130 @@
+# Hud
+
+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/hud`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hud
+
+Absolutely! Here's a README documentation for the `Hud` module and its classes and methods:
+
+---
+
+# Hud
+
+The `Hud` module provides a component-based rendering system integrated with the Rack framework.
+
+## Table of Contents
+
+- [Dependencies](#dependencies)
+- [Classes and Modules](#classes-and-modules)
+  - [Error](#error)
+  - [Display](#display)
+    - [Helpers](#helpers)
+    - [Component](#component)
+
+---
+
+## Dependencies
+
+- hud/version
+- hud/db/entity.rb
+- rack/app
+- tilt
+- ostruct
+- tilt/erb
+- rack/app/front_end
+
+---
+
+## Classes and Modules
+
+### Error
+
+A standard error class specific to `Hud`.
+
+### Display
+
+This class provides methods to handle the display of components.
+
+#### Helpers
+
+A module that provides helper methods for the display.
+
+##### `display(name, locals: {})`
+
+Displays a component by its name.
+
+*Example*:
+
+```ruby
+# Assuming you have a User component defined
+display(:user, locals: { name: 'Alice' })
+```
+
+#### Component
+
+A base class for all components. Components are meant to represent parts of the UI that can be reused across different views.
+
+##### `self.call(locals: {})`
+
+Creates a new instance of a component with the given locals.
+
+*Example*:
+
+```ruby
+UserComponent.call(locals: { name: 'Bob' })
+```
+
+##### `display(name, locals = {})`
+
+Displays a partial component by its name.
+
+*Example*:
+
+```ruby
+# Inside a component's view
+<%= display(:profile_picture, locals: { url: 'path/to/pic.jpg' }) %>
+```
+
+##### `to_s`
+
+Renders the component as a string. It looks for the component's template and renders it. If the template is not found, it prompts to create a view for the component.
+
+*Example*:
+
+```ruby
+user_component = UserComponent.new(locals: { name: 'Charlie' })
+puts user_component
+```
+
+---
+
+## Getting Started
+
+1. Define your components by extending `Hud::Display::Component`.
+2. Create a corresponding `.html.erb` template for each component inside a `components` directory.
+3. Use the `display` method to render components within other components or views.
+
+---
+
+Note: This README assumes that you have a basic understanding of Ruby and the Rack framework. Ensure that you set up your project structure correctly, especially the `components` directory for templates.
+
+---
+
+
+Remember to include necessary libraries like `SecureRandom`, `DateTime`, `SDBM`, and `MessagePack` in your project. Ensure that the `User` class (used in the examples) is defined with appropriate attributes for the examples to work.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/hud/version.rb

@@ -0,0 +1,3 @@
+module Hud
+  VERSION = '2.0.0'.freeze
+end

data/lib/hud.rb

@@ -0,0 +1,154 @@
+require "rack/app"
+require "yaml"
+require "tilt"
+require "ostruct"
+require "tilt/erb"
+require "rack/app/front_end"
+
+require_relative "hud/version"
+
+
+module Hud
+  def self.configuration
+    @configuration ||= OpenStruct.new
+  end
+
+  def self.configure
+    configuration.components_dirs = []
+    yield(configuration)
+  end
+   module Middleware
+
+    def self.included(base)
+      base.use Middleware::Version
+      base.use Middleware::Environment
+    end
+            
+    class Version
+      def initialize(app)
+        @app = app
+        manifest_path = File.join(File.dirname(__FILE__),'config', 'manifest.yml')
+        @version = YAML.load_file(manifest_path)['version']
+      end
+    
+      def call(env)
+        status, headers, response = @app.call(env)
+    
+        response_body = ''
+        response.each { |part| response_body << part }
+        version_div = "<div style='position:fixed; bottom:0; right:0; z-index:9999; background-color:rgba(255, 255, 255, 0.7); padding:5px;'>Version: #{@version}</div>"
+        response_body.sub!("</body>", "#{version_div}</body>")
+        headers["Content-Length"] = response_body.bytesize.to_s
+    
+        response = [response_body]
+    
+        [status, headers, response]
+      end
+    end
+    class Environment
+      def initialize(app)
+        @app = app
+      end
+    
+      def call(env)
+        status, headers, response = @app.call(env)
+    
+        color = 'green'
+        color = 'orange' if ENV['HARBR_ENV'] == "next"
+        color = 'red' if ENV['HARBR_ENV'] == "live" && env["HTTP_HOST"].include?("harbr.zero2one.ee")
+    
+        response_body = ''
+        response.each { |part| response_body << part }
+        indicator_div = "<div style='height:30px; width:100%; background-color:#{color}; position:absolute; top:0; z-index:9999;'>#{ENV['HARBR_ENV']&.upcase} ENVIRONMENT</div>"
+        response_body.sub!("<body>", "<body>#{indicator_div}")
+        headers["Content-Length"] = response_body.bytesize.to_s
+    
+        response = [response_body]
+    
+    
+        [status, headers, response]
+      end
+    end
+
+  end
+  
+
+  class Display
+    module Helpers
+      def display(name, from: nil, locals: {})
+        klz = Display.build(name)
+        klz.call(locals: locals).render_template(name: name, locals: @locals, from: from)
+      end
+    end
+
+    def self.build(name)
+      symbol = name.to_sym
+      class_name = symbol.to_s.capitalize
+      Object.const_set(class_name, Class.new(Component)) unless Object.const_defined?(class_name)
+      Object.const_get(class_name)
+    end
+
+    class Component
+      attr_reader :locals
+      attr_reader :content
+      alias_method :args, :locals
+
+      def folders
+        Hud.configuration.components_dirs
+      end
+
+      def development?
+        ENV["RACK_ENV"] == "development"
+      end
+
+      def production?
+        ENV["RACK_ENV"] == "production"
+      end
+
+      def staging?
+        ENV["RACK_ENV"] == "staging"
+      end
+
+      def self.call(locals: {})
+        new(locals: locals)
+      end
+
+      def render_template(name: nil, from: nil, locals: {})
+        name ||= self.class.to_s.downcase.gsub("::", "_")
+
+        base_path = Pathname.new(Rack::App::Utils.pwd)
+
+        paths_to_check = []
+
+        folders.each do |folder_name|
+          paths_to_check << base_path.join(folder_name, "components", "#{name}.html.erb")
+        end
+
+        root_component_path = base_path.join("components", "#{name}.html.erb")
+        paths_to_check << root_component_path
+
+        paths_to_check.each do |path|
+          if File.exist?(path)
+            template = Tilt::ERBTemplate.new(path)
+
+            if from.nil?
+              return template.render(self, locals)
+            else
+              from_path = base_path.join(from, "components")
+              return template.render(self, locals) if path.to_path.start_with? from_path.to_s
+            end
+
+          end
+        end
+
+        raise "cant find #{name} in #{paths_to_check.join(",")}"
+      end
+
+      private
+
+      def initialize(locals: {})
+        @locals = OpenStruct.new(locals)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hud
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Delaney Kuldvee Burke
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,7 +156,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".DS_Store"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/hud.rb
+- lib/hud/.DS_Store
+- lib/hud/version.rb
 homepage: https://github.com/dekubu/hud/
 licenses:
 - MIT