applin-rails 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b40b177f8a47a6f93c307dc0560b309568139b63623464378576c45aacee89
-  data.tar.gz: 59b2863cc28d76054a40dabbe79546fe4e011c6718ee921dcaabcdf53ebc530a
+  metadata.gz: 1f4baaac83d2c5def4823290b5ef402575bb7eb1ee52bc80bb7c8f1ffaea4b4e
+  data.tar.gz: 16620a1a0ace304554362ac721b083c1487eab83cb6bde26b7ff68b382804376
 SHA512:
-  metadata.gz: 4cd4ccd6ff7a418832c5776edc9d8012e359173f1f24ba25b2735b3656b0b22d713078d39cbf796d0460acc05e453eff0f7f80947ad9d1b7960d8c02ac5b0ba6
-  data.tar.gz: 960814c8a0d3740732e4fef1362388a679155711865d0b0f81f429d32dc0c003017ab042ff6fb1677c8ab3d0a8c4c49d86840f85abc217f3074558351e6ce380
+  metadata.gz: 741179d035939f3936c966302d2902c54d402afd09664daad8c2de9298bb875c7d20bb2d3d455766c4e75480f5a4d432b7f9df117a1c7f038f2468f8bed30284
+  data.tar.gz: f9c61d68b0e09010f4c82ae6100bc321f8cac684c695b56c460c08444b13b1e3ac976c86d050b35191e4d90bd2d5589c0f3552e4103862ad62f236452e402039

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
 
 Style/StringLiterals:
   Enabled: true

data/README.md

@@ -5,28 +5,24 @@ https://www.applin.dev/
 
 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/applin/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-## Installation
+## Install
+To add the gem to your Rails application:
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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.
+    $ bundle add applin-rails
 
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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 test` 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).
+## Use
+TODO
 
 ## Contributing
+Bug reports and pull requests are welcome on GitHub at <https://github.com/leonhard-llc/applin-rails>.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/leonhard-llc/applin-rails.
+## Development
+* Install dependencies: `bin/setup`
+* `rake test`
+* `bin/console`
+
+To release a new version:
+1. Install the gem onto your local machine: `bundle exec rake install`
+2. Test it with <https://github.com/leonhard-llc/applin-rails-example>
+1. Update the version number in `version.rb`
+1. Run `bundle exec rake release`.  This will create a git tag, make a `.gem` file, and push the file to <https://rubygems.org>.

data/lib/applin/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Applin
   module Rails
-    VERSION = "0.0.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/applin/rails.rb

@@ -1,10 +1,244 @@
 # frozen_string_literal: true
-
 require_relative "rails/version"
 
+# https://guides.rubyonrails.org/action_controller_overview.html#restful-downloads
+Mime::Type.register "application/vnd.applin_response", :applin_response
+
+ActionController::Renderers.add :applin_response do |obj, options|
+  body = { page: obj }.to_json
+  options[:type] = Mime[:applin_response]
+  send_data body, options
+end
+
 module Applin
   module Rails
-    class Error < StandardError; end
-    # Your code goes here...
+    ALIGN_CENTER = "center"
+    ALIGN_END = "end"
+    ALIGN_START = "start"
+    ALLOW_ALL = "all"
+    ALLOW_ASCII = "ascii"
+    ALLOW_EMAIL = "email"
+    ALLOW_NUMBERS = "numbers"
+    ALLOW_TEL = "tel"
+    AUTO_CAPITALIZE_NAMES = "names"
+    AUTO_CAPITALIZE_SENTENCES = "sentences"
+    DISPOSITION_FIT = "fit"
+    DISPOSITION_STRETCH = "stretch"
+    DISPOSITION_COVER = "cover"
+
+    def send_page(page, options = {})
+      body = { page: page }.to_json
+      options[:type] = Mime[:applin_response]
+      send_data body, options
+    end
+
+    def back_button(actions:)
+      { typ: :back_button, actions: actions }
+    end
+
+    def button(text:, actions:)
+      { typ: :button, text: text, actions: actions }
+    end
+
+    def checkbox(text:, var_name:, actions: nil, initial_bool: nil, rpc: nil)
+      {
+        typ: :checkbox,
+        actions: actions,
+        initial_bool: initial_bool,
+        rpc: rpc,
+        text: text,
+        var_name: var_name,
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def column(widgets:, align: nil, spacing: nil)
+      { typ: :column, align: align, spacing: spacing, widgets: widgets }.reject { |_k, v| v.nil? }
+    end
+
+    def empty
+      { typ: :empty }
+    end
+
+    def error_text(text)
+      { typ: :error_text, text: text }
+    end
+
+    def form(widgets:)
+      { typ: :form, widgets: widgets }
+    end
+
+    def form_button(text:, actions:, align: nil)
+      { typ: :form_button, align: align, text: text, actions: actions }.reject { |_k, v| v.nil? }
+    end
+
+    def form_section(widgets:, title: nil)
+      { typ: :form_section, title: title, widgets: widgets }.reject { |_k, v| v.nil? }
+    end
+
+    # `row_groups` is a an array of arrays of widgets.
+    def grouped_row_table(row_groups:, spacing: nil)
+      { typ: :grouped_row_table, spacing: spacing, row_groups: row_groups }.reject { |_k, v| v.nil? }
+    end
+
+    # Pass one of the DISPOSITION_* values for the `disposition` parameter.
+    def image(aspect_ratio:, url:, disposition: nil)
+      { typ: :image, disposition: disposition, aspect_ratio: aspect_ratio, url: url }.reject { |_k, v| v.nil? }
+    end
+
+    def last_error_text
+      { typ: :last_error_text }
+    end
+
+    def modal_button(text:, actions:, is_cancel: nil, is_default: nil, is_destructive: nil)
+      {
+        typ: :modal_button,
+        is_cancel: is_cancel,
+        is_default: is_default,
+        is_destructive: is_destructive,
+        text: text,
+        actions: actions,
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def ok_modal_button(is_default: true)
+      modal_button(text: "OK", is_default: is_default, actions: [pop])
+    end
+
+    def cancel_modal_button(is_default: false)
+      modal_button(text: "Cancel", is_default: is_default, actions: [pop])
+    end
+
+    def nav_button(text:, actions:, badge_text: nil, photo_url: nil, sub_text: nil)
+      {
+        typ: :nav_button,
+        badge_text: badge_text,
+        photo_url: photo_url,
+        sub_text: sub_text,
+        text: text,
+        actions: actions,
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def scroll(&widget_block)
+      { typ: :scroll, widget: widget_block.yield }
+    end
+
+    def text(text)
+      { typ: :text, text: text }
+    end
+
+    # Pass one of the ALLOW_* values for `allow`.
+    # Pass one of the AUTO_CAPITALIZE_* values for `auto_capitalize`.
+    def textfield(
+      var_name:, allow: nil,
+      auto_capitalize: nil,
+      error: nil,
+      initial_string: nil,
+      label: nil,
+      max_chars: nil,
+      max_lines: nil,
+      min_chars: nil
+    )
+      {
+        typ: :textfield,
+        allow: allow,
+        auto_capitalize: auto_capitalize,
+        error: error,
+        initial_string: initial_string,
+        label: label,
+        max_chars: max_chars,
+        max_lines: max_lines,
+        min_chars: min_chars,
+        var_name: var_name,
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def alert_modal(title:, modal_buttons:, stream: nil, poll_seconds: nil, text: nil)
+      {
+        typ: :alert_modal,
+        stream: stream,
+        poll_seconds: poll_seconds,
+        text: text,
+        title: title,
+        widgets: modal_buttons
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def drawer_modal(title:, modal_buttons:, stream: nil, poll_seconds: nil, text: nil)
+      {
+        typ: :drawer_modal,
+        stream: stream,
+        poll_seconds: poll_seconds,
+        text: text,
+        title: title,
+        widgets: modal_buttons
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def nav_page(title:, start: nil, end_: nil, stream: nil, poll_seconds: nil, &widget_block)
+      {
+        typ: :nav_page,
+        start: start,
+        end: end_,
+        title: title,
+        stream: stream,
+        poll_seconds: poll_seconds,
+        widget: widget_block.yield
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def plain_page(title: nil, stream: nil, poll_seconds: nil, &widget_block)
+      {
+        typ: :plain_page,
+        title: title,
+        stream: stream,
+        poll_seconds: poll_seconds,
+        widget: widget_block.yield
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def choose_photo(upload_url:)
+      "choose_photo:#{upload_url}"
+    end
+
+    def copy_to_clipboard(text)
+      "copy_to_clipboard:#{text}"
+    end
+
+    def launch_url(url)
+      "launch_url:#{url}"
+    end
+
+    def logout
+      "logout"
+    end
+
+    def nothing
+      "nothing"
+    end
+
+    def poll
+      "poll"
+    end
+
+    def pop
+      "pop"
+    end
+
+    def push(page_key)
+      "push:#{page_key}"
+    end
+
+    def replace_all(page_key)
+      "replace_all:#{page_key}"
+    end
+
+    def rpc(url)
+      "rpc:#{url}"
+    end
+
+    def take_photo(upload_url:)
+      "take_photo:#{upload_url}"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: applin-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Leonhard
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-28 00:00:00.000000000 Z
+date: 2023-09-04 00:00:00.000000000 Z
 dependencies: []
 description: Create mobile apps using only backend code.  Applin™ is a Server-Driven
   UI (SDUI) system.
@@ -23,7 +23,6 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- applin-rails.gemspec
 - lib/applin/rails.rb
 - lib/applin/rails/version.rb
 - sig/applin/rails.rbs
@@ -42,7 +41,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.2
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/applin-rails.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/applin/rails/version"
-
-Gem::Specification.new do |spec|
-  # https://guides.rubygems.org/publishing/
-  # https://guides.rubygems.org/specification-reference/
-  spec.name = "applin-rails"
-  spec.version = Applin::Rails::VERSION
-  spec.authors = ["Michael Leonhard"]
-  spec.email = ["michael@leonhardllc.com"]
-  spec.summary = "Applin™ server library for Ruby on Rails"
-  spec.description = "Create mobile apps using only backend code.  Applin™ is a Server-Driven UI (SDUI) system."
-  spec.homepage = "https://www.applin.dev/"
-  spec.license = "LicenseRef-LICENSE.md"
-  spec.required_ruby_version = ">= 3.2.2"
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/leonhard-llc/applin-rails"
-  spec.metadata["changelog_uri"] = "https://raw.githubusercontent.com/leonhard-llc/applin-rails/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end