its-showtime 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcf6e78f27132ffb8570155c3481dcf0377caa3418a499c2ac16202f68c0a7b2
-  data.tar.gz: 376948a57770e2899b8784fd4fa0f80f18f0b792605c6d4bdff6fbc3d107db47
+  metadata.gz: 834337794ce2ba312ccb6030482cc4d61fbaa0bd878754ca42d780ef57caa995
+  data.tar.gz: 5a8d5683a761f2148a4b690842f06677b467f8cc0deeb1ae2812d49f14990988
 SHA512:
-  metadata.gz: d2afbe962cd1d20a53d2dbe819fcf5db57a42b7191c694bd8d8ff71c786ed6b5b30be09355091a4d0862af526ef80b38d6a092eaa8fb5339426458d2debf35e6
-  data.tar.gz: 19401d14897ae2d7da472e4a117a018a122eb2316e8fe8ffe4d5a5004ad47a4e1321579d9da388e7678db77838f7d3adf0b41e94d53d88bd2bc94cf150a80c68
+  metadata.gz: e13f8f3b256f53ff551d2e0e4315335cf4eab6719ce0055896ffdca92a0d7e69053de804272900d020ac9a00dfaa068d1c402cac25bf36e148de198f0ac94404
+  data.tar.gz: f64b560bbb5c1e4f8f30c955e784e0fe4a67aa5a384ad1570946563b069d165cb79f6a3486b0c36db810a706d9b6b773544ec473011a1a7c4944b427dc876b36

data/README.md

@@ -113,6 +113,20 @@ Visit `http://localhost:8501` in your web browser to see your app in action.
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/glmaljkovich/showtime.
 
+### Commit Conventions
+
+This project uses Conventional Commits so `git-chglog` can generate changelogs. Configure hooks with:
+
+```bash
+git config core.hooksPath .githooks
+```
+
+Or run:
+
+```bash
+bundle exec rake setup_hooks
+```
+
 ### Development Requirements
 
 For development, you'll need:

data/lib/showtime/components/alerts.rb

@@ -64,20 +64,36 @@ module Showtime
   end
 
   module St
+    # Add an info alert to the current session.
+    #
+    # @param text [String] alert message
+    # @return [Showtime::Components::Info] created component
     def self.info(text)
       Showtime::session.add_element(Showtime::Components::Info.new(text))
     end
     
+    # Add a success alert to the current session.
+    #
+    # @param text [String] alert message
+    # @return [Showtime::Components::Success] created component
     def self.success(text)
       Showtime::session.add_element(Showtime::Components::Success.new(text))
     end
     
+    # Add a warning alert to the current session.
+    #
+    # @param text [String] alert message
+    # @return [Showtime::Components::Warning] created component
     def self.warning(text)
       Showtime::session.add_element(Showtime::Components::Warning.new(text))
     end
     
+    # Add an error alert to the current session.
+    #
+    # @param text [String] alert message
+    # @return [Showtime::Components::Error] created component
     def self.error(text)
       Showtime::session.add_element(Showtime::Components::Error.new(text))
     end
   end
-end 
+end 

data/lib/showtime/components/charts.rb

@@ -80,36 +80,78 @@ module Showtime
   end
 
   module St
+    # Add a line chart to the current session.
+    #
+    # @param data [Object] data to chart
+    # @param options [Hash] encoding and chart options (includes standard Plotly options for line charts)
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Hash, nil] chart spec payload
     def self.line_chart(data, options = {}, key: nil, help: nil)
       component = Showtime::Components::LineChart.new(data, options, key: key, help: help)
       Showtime::session.add_element(component)
       component.spec
     end
 
+    # Add a bar chart to the current session.
+    #
+    # @param data [Object] data to chart
+    # @param options [Hash] encoding and chart options (includes standard Plotly options for bar charts)
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Hash, nil] chart spec payload
     def self.bar_chart(data, options = {}, key: nil, help: nil)
       component = Showtime::Components::BarChart.new(data, options, key: key, help: help)
       Showtime::session.add_element(component)
       component.spec
     end
 
+    # Add a column chart to the current session.
+    #
+    # @param data [Object] data to chart
+    # @param options [Hash] encoding and chart options (includes standard Plotly options for column charts)
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Hash, nil] chart spec payload
     def self.column_chart(data, options = {}, key: nil, help: nil)
       component = Showtime::Components::ColumnChart.new(data, options, key: key, help: help)
       Showtime::session.add_element(component)
       component.spec
     end
 
+    # Add an area chart to the current session.
+    #
+    # @param data [Object] data to chart
+    # @param options [Hash] encoding and chart options (includes standard Plotly options for area charts)
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Hash, nil] chart spec payload
     def self.area_chart(data, options = {}, key: nil, help: nil)
       component = Showtime::Components::AreaChart.new(data, options, key: key, help: help)
       Showtime::session.add_element(component)
       component.spec
     end
 
+    # Add a pie chart to the current session.
+    #
+    # @param data [Object] data to chart
+    # @param options [Hash] label/value mapping options (includes standard Plotly options for pie charts)
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Hash, nil] chart spec payload
     def self.pie_chart(data, options = { label: :label, value: :value }, key: nil, help: nil)
       component = Showtime::Components::PieChart.new(data, options, key: key, help: help)
       Showtime::session.add_element(component)
       component.spec
     end
 
+    # Add a scatter plot to the current session.
+    #
+    # @param data [Object] data to chart
+    # @param options [Hash] encoding and chart options (includes standard Plotly options for scatter charts)
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Hash, nil] chart spec payload
     def self.scatter_plot(data, options = {}, key: nil, help: nil)
       component = Showtime::Components::ScatterPlot.new(data, options, key: key, help: help)
       Showtime::session.add_element(component)

data/lib/showtime/components/data.rb

@@ -313,14 +313,32 @@ module Showtime
   end
 
   module St
+    # Add a JSON viewer element to the current session.
+    #
+    # @param data [Object] data to render as JSON
+    # @return [Showtime::Components::Json] created component
     def self.json(data)
       Showtime::session.add_element(Showtime::Components::Json.new(data))
     end
     
+    # Add a table element to the current session.
+    #
+    # @param data [Object] table data
+    # @param page_size [Integer] number of rows per page
+    # @param current_page [Integer] initial page number
+    # @param key [Object, nil] component key
+    # @return [Showtime::Components::Table] created component
     def self.table(data, page_size: 10, current_page: 1, key: nil)
       Showtime::session.add_element(Showtime::Components::Table.new(data, page_size: page_size, current_page: current_page, key: key))
     end
     
+    # Add a dataframe element to the current session.
+    #
+    # @param data [Object] dataframe data
+    # @param page_size [Integer] number of rows per page
+    # @param current_page [Integer] initial page number
+    # @param key [Object, nil] component key
+    # @return [Showtime::Components::DataFrame] created component
     def self.dataframe(data, page_size: 10, current_page: 1, key: nil)
       Showtime::session.add_element(Showtime::Components::DataFrame.new(data, page_size: page_size, current_page: current_page, key: key))
     end

data/lib/showtime/components/inputs.rb

@@ -343,46 +343,139 @@ module Showtime
   end
 
   module St
+    # Add a button element to the current session.
+    #
+    # @param label [String] button label
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::Button] created component
     def self.button(label, key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::Button.new(label, key: key, help: help))
     end
     
+    # Add a checkbox element to the current session.
+    #
+    # @param label [String] checkbox label
+    # @param value [Boolean] initial checked state
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::Checkbox] created component
     def self.checkbox(label, value: false, key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::Checkbox.new(label, value: value, key: key, help: help))
     end
     
+    # Add a text input element to the current session.
+    #
+    # @param label [String] input label
+    # @param value [String] initial value
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::TextInput] created component
     def self.text_input(label, value: "", key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::TextInput.new(label, value: value, key: key, help: help))
     end
     
+    # Add a number input element to the current session.
+    #
+    # @param label [String] input label
+    # @param min_value [Numeric, nil] minimum value
+    # @param max_value [Numeric, nil] maximum value
+    # @param value [Numeric, nil] initial value
+    # @param step [Numeric] step size
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::NumberInput] created component
     def self.number_input(label, min_value: nil, max_value: nil, value: nil, step: 1, key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::NumberInput.new(label, min_value: min_value, max_value: max_value, value: value, step: step, key: key, help: help))
     end
     
+    # Add a text area element to the current session.
+    #
+    # @param label [String] input label
+    # @param value [String] initial value
+    # @param height [Integer, nil] height in pixels
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @param kwargs [Hash] additional component options
+    # @return [Showtime::Components::TextArea] created component
     def self.text_area(label, value: "", height: nil, key: nil, help: nil, **kwargs)
       Showtime::session.add_element(Showtime::Components::TextArea.new(label, value: value, height: height, key: key, help: help, **kwargs))
     end
     
+    # Add a date input element to the current session.
+    #
+    # @param label [String] input label
+    # @param value [String, Date, nil] initial value
+    # @param min_value [String, Date, nil] minimum value
+    # @param max_value [String, Date, nil] maximum value
+    # @param format [String] display format string
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::DateInput] created component
     def self.date_input(label, value: nil, min_value: nil, max_value: nil, format: 'YYYY-MM-DD', key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::DateInput.new(label, value: value, min_value: min_value, max_value: max_value, format: format, key: key, help: help))
     end
     
+    # Add a file uploader element to the current session.
+    #
+    # @param label [String] input label
+    # @param type [Array<String>, String, nil] allowed file extensions or mime types
+    # @param accept_multiple_files [Boolean] allow multiple file selection
+    # @param max_size [Integer] maximum file size in bytes
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @param wide [Boolean] render a full-width uploader when true
+    # @return [Showtime::Components::FileUploader] created component
     def self.file_uploader(label, type: nil, accept_multiple_files: false, max_size: Showtime::Components::FileUploader::DEFAULT_MAX_SIZE, key: nil, help: nil, wide: false)
       Showtime::session.add_element(Showtime::Components::FileUploader.new(label, type: type, accept_multiple_files: accept_multiple_files, max_size: max_size, key: key, help: help, wide: wide))
     end
     
+    # Add a select element to the current session.
+    #
+    # @param label [String] input label
+    # @param options [Array<Object>] selectable options
+    # @param value [Object, nil] initial value
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::Select] created component
     def self.select(label, options, value: nil, key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::Select.new(label, options, value: value, key: key, help: help))
     end
     
+    # Add a multiselect element to the current session.
+    #
+    # @param label [String] input label
+    # @param options [Array<Object>] selectable options
+    # @param default [Array<Object>] default selections
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::Multiselect] created component
     def self.multiselect(label, options, default: [], key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::Multiselect.new(label, options, default: default, key: key, help: help))
     end
     
+    # Add a slider element to the current session.
+    #
+    # @param label [String] input label
+    # @param min_value [Numeric] minimum value
+    # @param max_value [Numeric] maximum value
+    # @param value [Numeric, nil] initial value
+    # @param step [Numeric] step size
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::Slider] created component
     def self.slider(label, min_value: 0, max_value: 100, value: nil, step: 1, key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::Slider.new(label, min_value: min_value, max_value: max_value, value: value, step: step, key: key, help: help))
     end
     
+    # Add a radio group element to the current session.
+    #
+    # @param label [String] input label
+    # @param options [Array<Object>] selectable options
+    # @param index [Integer] default selected index
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::Radio] created component
     def self.radio(label, options, index: 0, key: nil, help: nil)
       Showtime::session.add_element(Showtime::Components::Radio.new(label, options, index: index, key: key, help: help))
     end

data/lib/showtime/components/layout.rb

@@ -81,6 +81,16 @@ module Showtime
   end
 
   module St
+    # Create a container and add any yielded elements as children.
+    #
+    # @param title [String, nil] optional heading for the container
+    # @param border [Boolean] render a border around the container when true
+    # @param grow [Boolean] allow the container to grow and fill space when true
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @yield block that builds the container's children
+    # @yieldreturn [void]
+    # @return [Showtime::Components::Container] created container
     def self.container(title: nil, border: true, grow: false, key: nil, help: nil, &block)
       container = Showtime::Components::Container.new(title: title, border: border, grow: grow, key: key, help: help)
       element = Showtime::session.add_element(container)
@@ -104,8 +114,11 @@ module Showtime
     #   so sibling panels align; when omitted, equal distribution across 24 columns is used.
     # @param height [Integer, String, nil] optional height for vertical layouts (number => px, string => CSS value)
     # @param type [String] visual style for the container (card/ghost/success/info/warning/error)
-    # @param key [String, nil] component key
+    # @param key [Object, nil] component key
     # @param help [String, nil] optional tooltip/help text
+    # @yield block that builds the container's children
+    # @yieldreturn [void]
+    # @return [Showtime::Components::SplitLayout] created container
     def self.split_layout(direction: 'horizontal', sizes: nil, height: nil, type: 'card', key: nil, help: nil, &block)
       container = Showtime::Components::SplitLayout.new(direction: direction, sizes: sizes, height: height, ttype: type, key: key, help: help)
       element = Showtime::session.add_element(container)
@@ -119,6 +132,15 @@ module Showtime
       element
     end
 
+    # Create a collapsible container and add any yielded elements as children.
+    #
+    # @param label [String] label displayed on the collapse header
+    # @param expanded [Boolean] initial expanded state
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @yield block that builds the container's children
+    # @yieldreturn [void]
+    # @return [Showtime::Components::Collapse] created container
     def self.collapse(label, expanded: false, key: nil, help: nil, &block)
       container = Showtime::Components::Collapse.new(label, expanded: expanded, key: key, help: help)
       element = Showtime::session.add_element(container)

data/lib/showtime/components/media.rb

@@ -65,6 +65,15 @@ module Showtime
   end
 
   module St
+    # Add an image to the current session.
+    #
+    # @param src [String, Object] file path, URL, data URI, or binary data
+    # @param caption [String, nil] caption text displayed with the image
+    # @param width [Integer, nil] width in pixels
+    # @param use_column_width [Boolean] stretch to container width when true
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::Image] created component
     def self.image(src, caption: nil, width: nil, use_column_width: false, key: nil, help: nil)
       component = Components::Image.new(src, caption: caption, width: width, use_column_width: use_column_width, key: key, help: help)
       Showtime.session.add_element(component)

data/lib/showtime/components/sidebar.rb

@@ -123,6 +123,9 @@ module Showtime
   end
 
   module St
+    # Create a sidebar container for subsequent elements.
+    #
+    # @return [Showtime::Components::Sidebar] sidebar container
     def self.sidebar
       Showtime::Components::Sidebar.new
     end

data/lib/showtime/components/text.rb

@@ -120,33 +120,76 @@ module Showtime
   end
 
   module St
+    # Add a page title element to the current session.
+    #
+    # @param text [String] title text
+    # @param divider [Boolean] render a divider below the title when true
+    # @param help [String, nil] helper text shown in the UI
+    # @param anchor [Boolean] generate an anchor link when true
+    # @return [Showtime::Components::Title] created component
     def self.title(text, divider: false, help: nil, anchor: true)
       anchor_enabled = anchor && !Showtime::session.in_sidebar?
       Showtime::session.add_element(Showtime::Components::Title.new(text, divider, help, anchor_enabled))
     end
     
+    # Add a header element to the current session.
+    #
+    # @param text [String] header text
+    # @param divider [Boolean] render a divider below the header when true
+    # @param help [String, nil] helper text shown in the UI
+    # @param anchor [Boolean] generate an anchor link when true
+    # @return [Showtime::Components::Header] created component
     def self.header(text, divider: false, help: nil, anchor: true)
       anchor_enabled = anchor && !Showtime::session.in_sidebar?
       Showtime::session.add_element(Showtime::Components::Header.new(text, divider, help, anchor_enabled))
     end
     
+    # Add a subheader element to the current session.
+    #
+    # @param text [String] subheader text
+    # @param divider [Boolean] render a divider below the subheader when true
+    # @param help [String, nil] helper text shown in the UI
+    # @param anchor [Boolean] generate an anchor link when true
+    # @return [Showtime::Components::Subheader] created component
     def self.subheader(text, divider: false, help: nil, anchor: true)
       anchor_enabled = anchor && !Showtime::session.in_sidebar?
       Showtime::session.add_element(Showtime::Components::Subheader.new(text, divider, help, anchor_enabled))
     end
     
+    # Alias for {#text}.
+    #
+    # @param text [String] text content
+    # @return [Showtime::Components::Text] created component
     def self.write(text)
       self.text(text)
     end
     
+    # Add a text element to the current session.
+    #
+    # @param text [String] text content
+    # @return [Showtime::Components::Text] created component
     def self.text(text)
       Showtime::session.add_element(Showtime::Components::Text.new(text))
     end
 
+    # Add a markdown element to the current session.
+    #
+    # @param content [String] markdown content
+    # @return [Showtime::Components::Markdown] created component
     def self.markdown(content)
       Showtime::session.add_element(Showtime::Components::Markdown.new(content))
     end
 
+    # Add a metric element to the current session.
+    #
+    # @param label [String] label displayed for the metric
+    # @param value [Object] main value shown
+    # @param delta [Object, nil] delta value shown alongside the metric
+    # @param prefix [String, nil] prefix for the value display
+    # @param suffix [String, nil] suffix for the value display
+    # @param key [Object, nil] component key
+    # @param help [String, nil] helper text shown in the UI
+    # @return [Showtime::Components::Metric] created component
     def self.metric(label, value:, delta: nil, prefix: nil, suffix: nil, key: nil, help: nil)
       Showtime::session.add_element(
         Showtime::Components::Metric.new(label, value: value, delta: delta, prefix: prefix, suffix: suffix, key: key, help: help)

data/lib/showtime/version.rb

@@ -1,3 +1,3 @@
 module Showtime
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end 

data/lib/showtime.rb

@@ -91,7 +91,11 @@ module Showtime
   # The main module for streamlit-like API
   module St
     @@color = Pastel.new
-    # Get a value from the cache, recomputing only if dependencies changed
+    # Get a value from the cache, recomputing only if dependencies changed.
+    #
+    # @param key [Object] cache key for the computed value
+    # @yieldreturn [Object] value to compute when cache is missing or dirty
+    # @return [Object] cached or freshly computed value
     def self.compute(key, &block)
       session = Showtime.session
       registry = session.component_registry
@@ -121,6 +125,12 @@ module Showtime
       tracker.result
     end
     
+    # Fetch a cached value, optionally computing it when missing.
+    #
+    # @param key [Object] cache key for the value
+    # @param default [Object] fallback value when not cached and no block is given
+    # @yieldreturn [Object] value to compute when missing
+    # @return [Object] cached value, computed value, or default
     def self.get(key, default = nil, &block)
       session = Showtime.session
       
@@ -139,14 +149,26 @@ module Showtime
       default
     end
 
+    # Store a value in the session cache.
+    #
+    # @param key [Object] cache key
+    # @param value [Object] value to store
+    # @return [void]
     def self.set(key, value)
       Showtime.session.update_value(key, value)
     end
 
+    # Clear all cached values in the current session.
+    #
+    # @return [void]
     def self.clear_session
       Showtime.session.clear_values
     end
 
+    # Resolve a path relative to the app root.
+    #
+    # @param relative_path [String] relative path from the app root
+    # @return [String] absolute path
     def self.path(relative_path)
       Showtime::Helpers.absolute_path(relative_path)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: its-showtime
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Gabriel L. Maljkovich
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-11 00:00:00.000000000 Z
+date: 2026-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra