basemate-ui-core 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ac9b8956925c1cdd0eae977d3f19d8cd23f38e35ad71e0469b42dbd37156435
-  data.tar.gz: 820ba59a13fd487c341e5ef03f05cc35c37a782f6bfa0c993ad0f4b9473f48b6
+  metadata.gz: cd8315d25c6eeaeecd3fe279c87e167541501255b69d44dd55ae501c33ec5ec0
+  data.tar.gz: 220017e1c1d2c4a22cffc6a4027a125a55cc56ce706803de088cb59d1eabc7d3
 SHA512:
-  metadata.gz: 100808d78f1d6c5be08109df1a9557ceebf2abbc62d8944e6d18bc463b707f9d8691c6fca29798c101c3f4fb8fc288ebeff8f5fadd108b8d6a7ea820a5d39a51
-  data.tar.gz: 3074d0031b6dd7fe2d917cad0f31aeb6ec24c9b8d0f8964fd031b393777a6782f44ca157c5221688e3dc1884903d3b2c67054cee48ba19897c8786744c3cb36b
+  metadata.gz: c2a4bf9f869fb4b2069405ae6c551466686f433c94a50b88127487ac5741a7dbd69d99779c46e140fd3a4e7dc363829d721a13b37b9c1e0048681bb34dab4a81
+  data.tar.gz: 31f55cbcb9c1fd0142a54f0661cd61908a25a39f3d308065443d04ff11e270d6e9c14a41e851bd988e604e9ce38057fff6c3e2e2951f2d4637d71274c5f8b5d1

data/README.md

@@ -3,13 +3,14 @@
 Create component based, object oriented views. Get dynamic SPA-like behaviour
 through integrated vue.js with zero effort.
 
-## Purpose
-
-TODO
-
 ## Why basemate?
 
-TODO
+### Our why:
+Frontend development has gotten unnecessarily complex, messy and expensive. Implementing responsive, basic user interfaces often keeps us from creating the really valuable juice (= business logic).
+### Our how:
+We're replacing the original view-layer of Ruby on Rails, the most productive MVC framework we know, with our technology. By introducing basemate we get dynamic, fast and simple user interfaces without the need to touch HTML/HAML/ERB/JS/CSS. Plus, it feels like a single page application, but there's no need for all the API hustle SPAs usually bring with them.
+### Our what:
+basemate. Declarative frontend solutions.
 
 ## Current State
 This repo is currently under heavy development and should not be used until the
@@ -17,478 +18,11 @@ first tested, stable version is released. Please use it only after being
 onboarded by the basemate team. Feel free to reach out if you really can't
 wait to start :)
 
-First stable release is scheduled for mid October 2018.
-
-## Table of Contents
-1. [Setup](#setup)
-2. [Usage](#usage)
-3. [Customize](#customize)
-4. [Bundles](#bundles)
-5. [Themes](#themes)
-6. [Contribution](#contribution)
-7. [License](#license)
-
-## Setup
-This setup part documents the simplest approach to use Basemate::Ui::Core
-without any basemate bundle or theme involved. Assets are compiled and served
-only via sprockets. This makes it very easy to integrate it in a classic Rails
-project without any further dependencies.
-**Do not use this setup if you want to build custom vue.js components.**
-If you want to extend basemate by building your own vue.js components,
-use Webpacker (see: [Setup with Webpacker](#setup-with-webpacker)).
-
-### Gemfile
-
-Add 'basemate-ui-core' to your Gemfile
-
-```ruby
-gem 'basemate-ui-core', :git => 'https://github.com/basemate/basemate-ui-core.git'
-```
-
-and run
-````
-$ bundle install
-````
-
-### Javascript
-
-Require 'basemate-ui-core' in your assets/javascript/application.js
-
-```
-//= require basemate-ui-core
-```
-
-### Basemate Folder
-
-Create a folder called 'basemate' in your app directory. All your basemate apps,
-pages, components (and more to come) will be defined there.
-
-### Include Helper
-
-Add the basemate Helper to your controllers. If you want to make the helpers
-available in all controllers, add it to your 'ApplicationController' this way:
-
-app/controllers/application_controller.rb
-```ruby
-class ApplicationController < ActionController::Base
-  include Basemate::Ui::Core::ApplicationHelper
-end
-```
-
-## Usage
-
-- [Basemate Page](#basemate-page)
-  - [Setup](#basic-page-setup)
-  - [Partials](#structure-your-basemate-page-response-with-partials)
-  - [Prepare Block](#use-the-prepare-method-to-implement-page-related-business-logic)
-  - [Iterators](#use-iterators)
-- [Basemate App](#basemate-app)
-  - [Setup](#basic-app-setup)
-
-### Basemate Page
-
-#### Basic Page Setup
-Scenario: You want to use a basemate Page instead of a classic Rails view as a
-response for a controller action. This is what your setup looks like:
-
-Your routes:
-
-config/routes.rb
-```ruby
-Rails.application.routes.draw do
-  get '/home', to:'website#home'
-end
-```
-
-Your Application Layout:
-
-app/views/layouts/application.html.erb
-```erb
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>My App</title>
-    <%= csrf_meta_tags %>
-    <%= csp_meta_tag %>
-
-    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
-    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
-  </head>
-
-  <body>
-    <div id="basemate_ui">
-      <%= yield %>
-    </div>
-  </body>
-</html>
-```
-Note: Wrap your content with a div and assgin the id  "basemate_ui"
-
-Your Controller Action:
-
-app/controllers/website_controller.rb
-```ruby
-class WebsiteController < ApplicationController
-
-  def home
-    @foo = "foo"
-    @bar = "bar"
-    responder_for(Website::Home) #-> Basemate::Ui::Core::ApplicationHelper
-  end
-
-end
-```
-
-Your basemate Page:
-
-app/basemate/website/home.rb
-```ruby
-module Website
-  class Home < Page::Cell::Page
-
-    def response
-
-      components {
-        row do
-          col do
-            plain @foo
-          end
-          col id: "my_special_col" do
-            plain @bar
-          end
-        end
-      }
-
-    end
-
-  end
-end
-```
-This gives you following output:
-
-```html
-<div id='website_home'>
-  <div class='row' id="row_1">
-    <div class='col' id="row_1__col_1">
-      foo
-    </div>
-    <div class='col' id="my_special_col">
-      bar
-    </div>
-  </div>
-</div>
-```
-As you can see, each component receives an id that is automatically created
-using the components' name. Those ids should help you style specific parts of
-your page later on, and can be overwritten in the page response if you need more freedom. 
-
-Note:
-- "row", "col", "plain" are predefined core components
-  - a documentation of predefined core component can be found here: TODO
-- row/col class setup for bootstrap 4.x and material-design-lite can be found here:
-  - bootstrap 4.x: TODO
-  - material-design-lite: TODO
-- you can customize the output of the core components
-  - see: [Customize](#customize)
-- you can add your own components
-  - see: [Customize](#customize)
-- you can use styles from Basemate Themes
-  - see: [Themes](#themes)
-- you can use components from Basemate Bundles
-  - see: [Bundles](#bundles)
-
-#### Structure your basemate Page response with partials
-
-If you don't want to define the response of you page in one block, you can use
-partials.
-
-Let's take our app/basemate/website/home.rb and refactor it from this:
-
-```ruby
-module Website
-  class Home < Page::Cell::Page
-
-    def response
-
-      components {
-        row do
-          col do
-            plain @foo
-          end
-          col do
-            plain @bar
-          end
-        end
-        row do
-          col do
-            plain "hello"
-          end
-          col do
-            plain "world"
-          end
-        end
-      }
-
-    end
-
-  end
-end
-
-```
-
-to this:
-
-```ruby
-module Website
-  class Home < Page::Cell::Page
-
-    def response
-      components {
-        partial :row_1
-        partial :row_2
-      }
-    end
-
-    def row_1
-      partial {
-        row do
-          col do
-            plain @foo
-          end
-          col do
-            plain @bar
-          end
-        end
-      }
-    end
-
-    def row_2
-      partial {
-        row do
-          col do
-            plain "hello"
-          end
-          col do
-            plain "world"
-          end
-        end
-      }
-    end
-
-
-  end
-end
-
-```
-
-You could also implement dynamic partials, for example:
-
-```ruby
-module Website
-  class Home < Page::Cell::Page
-
-    def response
-      components {
-        partial :row, @foo, @bar
-        partial :row, "hello", "world"
-      }
-    end
-
-    def row first_col, second_col
-      partial {
-        row do
-          col do
-            plain first_col
-          end
-          col do
-            plain second_col
-          end
-        end
-      }
-    end
-
-  end
-end
-
-```
-#### Use the Prepare method to implement page-related business logic
-
-If you want to move code out of your controller action, you could place your
-page-related business logic in the 'prepare'-method of your Basemate Page.
-
-
-app/controllers/website_controller.rb
-```ruby
-class WebsiteController < ApplicationController
-
-  def home
-    #@foo = "foo" #moved to prepare method
-    #@bar = "bar" #moved to prepare method
-    responder_for(Website::Home)
-  end
-
-end
-
-```
-
-app/basemate/website/home.rb
-```ruby
-module Website
-  class Home < Page::Cell::Page
-
-    def prepare
-      @foo = "foo"
-      @bar = "bar"
-    end
-
-    def response
-      components {
-        row do
-          col do
-            plain @foo
-          end
-          col do
-            plain @bar
-          end
-        end
-      }
-    end
-
-  end
-end
-
-```
-
-#### Use Iterators
-
-Often you need to iterate through some datastructure on your UI. Since you're
-writing pure Ruby, it's straight forward. Iterations can use dynamic partials:
-
-app/basemate/website/home.rb
-```ruby
-module Website
-  class Home < Page::Cell::Page
-
-    def prepare
-      @team_members = ["Mike", "Laura", "John"]
-    end
-
-    def response
-      components {
-        @team_members.each do |member|
-          partial :member_profile, member
-        end
-      }
-    end
-
-    def member_profile member
-      partial {
-        row do
-          col do
-            plain member
-          end
-        end
-      }
-    end
-  end
-end
-
-```
-
-### Basemate App
-
-### Basic App Setup
-
-TODO
-
-
-## Customize
-
-### Customize Core Components
-
-Add a ruby file to the correct basemate customize folder, for example:
-
-app/basemate/customize/ui/core/row.rb
-```ruby
-
-module Customize::Ui::Core
-  class Row
-
-    def row_classes(classes, options)
-      classes << "justify-content-md-center" if options[:center] == true
-    end
-
-  end
-end
-```
-
-and change your Basemate Page to use your new interface:
-
-app/basemate/website/home.rb
-```ruby
-module Website
-  class Home < Page::Cell::Page
-
-    def response
-
-      components {
-        row center: true do
-          col do
-            plain @foo
-          end
-          col do
-            plain @bar
-          end
-        end
-      }
-
-    end
-
-  end
-end
-
-```
-The result is the following, customized output:
-
-```html
-<div class='row justify-content-md-center'>
-  <div class='col'>
-    foo
-  </div>
-  <div class='col'>
-    bar
-  </div>
-</div>
-```
-### Create your own Component
-
-TODO
-
-### Setup with Webpacker
-
-TODO
-
-## Bundles
-
-TODO
-
-## Templates
-
-TODO
-
-## Contribution
-
-### Core
-
-TODO
-
-### Bundles
-
-TODO
+## Documentation
 
-### Themes
+Documentation is built with basemate and hosted here: [Docs](https://basemate-ui-core.herokuapp.com)
 
-TODO
+Source code of documentation can be found here: [Docs Source](https://github.com/basemate/basemate-ui-core-docs)
 
 ## License
 The gem is available as open source under the terms of the

data/lib/basemate/ui/core/version.rb

@@ -1,7 +1,7 @@
 module Basemate
   module Ui
     module Core
-      VERSION = '0.2.1'
+      VERSION = '0.2.2'
     end
   end
 end

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: basemate-ui-core
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Jonas Jabari
 - Pascal Wengerter
+- Christopher Bastert
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -103,6 +104,7 @@ description: We're replacing the original view-layer of Ruby on Rails, the most
 email:
 - jonas@basemate.io
 - pascal@basemate.io
+- chris@basemate.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -173,7 +175,8 @@ files:
 homepage: https://basemate.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/basemate/basemate-ui-core
 post_install_message: 
 rdoc_options: []
 require_paths: