menilite 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e96823093a09cbe81fe57e93acb586d480258fb6
-  data.tar.gz: 1c1698195f5afb071265a644f0b5f725d04fc1a3
+  metadata.gz: 2228ad770fdb5fc5a5343e3c27644c350c623e86
+  data.tar.gz: 0cc3d1e02e37a9a080e639f83c0ada12a23d87e2
 SHA512:
-  metadata.gz: 16f926123ff653a696b6b1fea7477de86fa51fe2776708202886518c214cce4284f6e47a043df4d285804793c12dc2a262793ccb3f8f71be1157a6c98af464b0
-  data.tar.gz: a5190655a95e355561b5f15f55fe96bd7d654134aad86bf46678a115cccd52e537ee9fd205ec34565a0111f5077e76d28f76fe95baf561cb0c9a3ff9173dd014
+  metadata.gz: c3d37d812e06e8c8f34c6b728d145a1895722809981252a7e8f2f1f0f77b37aad4dda12176a5581d6506ac06ff538b8dbeff1b3c753f65e341e4c9800aec0804
+  data.tar.gz: cdda6647a91b84a2617df44ed5c85f1ca9d785e9402e15da7c95eb4e8477fba3d56350ab9e65e4f5b6339ee7c30097c532f714def55b53f5c6a8466f66547058

data/README.md

@@ -1,8 +1,7 @@
 # Menilite
 
-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/menilite`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An isomophic web programming framework in Ruby.  
+Ruby codes also run on the client side by using [Opalrb](http://opalrb.org).
 
 ## Installation
 
@@ -20,17 +19,71 @@ Or install it yourself as:
 
     $ gem install menilite
 
-## Usage
+## How to use
+
+You can generate the template project by [Silica](https://github.com/youchan/silica) to get started.
+
+    $ gem install silica
+    $ silica new your-app
+    $ cd your-app
+    $ bundle install
+    $ bundle exec rackup
+
+## Model definition
+
+```ruby
+class User < Menilite::Model
+    field :name
+    field :password
+end
+```
+
+Model definition is shared from the client side (compiled by Opal) and the server side (in MRI).  
+In this tiny example, `User` model has two string fields (`name` and `password`).  
+Field has a type and the type is set `string` as default.  
+You can specify another type by the following way, for example.
+
+    field :active, :boolean
+
+## Action
 
-TODO: Write usage instructions here
+```ruby
+class User < Menilite::Model
+  action :signup, on_create: true do |password|
+    self.password = BCrypt::Password.create(password)
+    self.save
+  end
+end
+```
+
+Models can have actions. The action is executed on the server side and the client code call the action as a method.
 
-## Development
+on the client side
+
+```ruby
+user = User.new(name: 'youchan')
+user.auth('topsecret')
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Controller
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Controllers can have actions too.
 
-## Contributing
+```ruby
+class ApplicationController < Menilite::Controller
+  action :login do |username, password|
+    user = User.find(name: username)
+    if user && user.auth(password)
+      session[:user_id] = user.id
+    else
+      raise 'login failed'
+    end
+  end
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/menilite.
+The action of Controller is defined as a class method on the client side.
 
+```ruby
+ApplicationController.login('youchan', 'topsecret')
+```

data/lib/menilite/controller.rb

@@ -35,7 +35,7 @@ module Menilite
         action_info[name.to_s] = ActionInfo.new(name, block.parameters, options)
         if RUBY_ENGINE == 'opal'
           method = Proc.new do |*args, &callback| # todo: should adopt keyword parameters
-            action_url = self.respond_to?(:namespace) ? "api/#{self.class.namespace}/#{name}" : "api/#{name}"
+            action_url = self.respond_to?(:namespace) ? "api/#{self.namespace}/#{name}" : "api/#{name}"
             post_data = {}
             post_data[:args] = args
             Browser::HTTP.post(action_url, post_data.to_json) do

data/lib/menilite/version.rb

@@ -1,3 +1,3 @@
 module Menilite
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: menilite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - youchan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler