framework7-rails 0.7.4.0 → 0.9.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11e8ce51feb9ce116f9e303434a92a1168702abd
-  data.tar.gz: 05db8570c39cc12a1871833824361c0b5212889c
+  metadata.gz: a2ba8e602132ea3cb757f45c6e4804b0fc467c9b
+  data.tar.gz: 2b292a842226449526496ec5c85953f136c57144
 SHA512:
-  metadata.gz: c4fb08aebc439ceb2addcdc2a4db89c875f1071b16de2b958635f026004ef632028a09466518374b8fbe39a3ed752422da28a7a3278ed6a737903956935fc412
-  data.tar.gz: 874adf1ae3ca6a6cca48d1f4dbaae755edaa9224caa8e5816af8aa8524c9201464fb0bf13493c4d42c17447e84302cd0dfd44138229b679ce380ad9a917d099a
+  metadata.gz: 1f29aa1226eac22f9555991ff787326b16c1fdfb17eccb0ac5e0d37295cf1afe27d71778b1a014b98e6c14f92bc109dd221df778cf08de81dc2972aa08ea1df9
+  data.tar.gz: 2a70ef7cb2876d16a5cb08168c442869a62ef6674615af2a2381cf77cf66b1f3a06317e6759e3a4b092f742a5221edcc4399dd59d9c5556a10ae241e8b595ae4

data/README.md

@@ -3,9 +3,9 @@
 [![Gem Version](https://badge.fury.io/rb/framework7-rails.svg)](http://badge.fury.io/rb/framework7-rails)
 
 Brings the excellent [Framework7](https://github.com/nolimits4web/framework7/)
-into the Rails 3.1+ Asset Pipeline.
+into the Rails 3.1.x - 4.x Asset Pipeline.
 
-The gem version number ``x.y.z`` is kept in sync with the version of Framework7
+The gem version number `x.y.z` is kept in sync with the version of Framework7
 being supported.
 
 ## Installation
@@ -13,6 +13,10 @@ being supported.
 Add this line to your application's Gemfile:
 
     gem 'framework7-rails'
+    
+If you want bleeding edge, not yet in ruby gems version, add this instead:
+
+    gem 'framework7-rails', :git => 'https://github.com/twss/framework7-rails.git'`
 
 And then execute:
 
@@ -30,8 +34,6 @@ The easiest way to set up ready for use is to use the generator
 
 You can do it manually if you want to, as outlined below:
 
-### Development/Debugging
-
 In your application.js file, add the line:
 
     //= require framework7
@@ -39,16 +41,7 @@ In your application.js file, add the line:
 In your application.css file, add the line:
 
     *= require framework7
-
-### Production
-
-In your application.js file, add the line:
-
-    //= require framework7.min
-   
-In your application.css file, add the line:
-
-    *= require framework7.min
+    *= require framework7.theme
 
 ## Generators
 
@@ -60,33 +53,30 @@ This generator will add the necessary require statements as outlined above.
 
 This sets up an application-level layout, and will generate two files:
 
-    app/assets/javascripts/<app_name>.js.coffee
+    app/assets/javascripts/<app_name>.js or app/assets/javascripts/<app_name>.coffee
     app/views/layouts/application.html.erb
-    
-The javascript file creates a wrapping class around the main `Framework7` class.
-This new class is named after your application, an instance is created with the
-lower camel-cased application.
 
-e.g If you did `rails new contacts_app` the javascript file will contain:
+For now, at least, the javascript generated has been scaled back, to be:
 
-    var contactsApp;
-    
-    ContactsApp = function() {
-      ...
-    };
-    
-    contactsApp = new ContactsApp();
+```javascript
+window.F7H = {
+  app: new Framework7(),
+  dom: Dom7
+};
 
-If you ever need to get back to the Framework7 application instance, this is
-achieved as follows:
+window.Phone = {
+  Views: {}
+};
+
+Phone.Views.Main = F7H.app.addView('.view-main', {
+  dynamicNavbar: true
+});
+```
+
+### f7:install:examples
+
+*Removed, as they didn't really add anything of value.*
 
-    app = contactsApp.getInstance();
-    
-This may be necessary for future plans, but not too sure. For now it will be
-left in, but you can always fallback to the Framework7 native way of doing
-things by using the above line and never touching that `contactsApp` variable
-again.
-    
 ### And there's more...
 
 To find out about the rest of the generators, be sure to 
@@ -95,21 +85,36 @@ be updated as more become available.
 
 ## Helpers
 
-None yet, but this will be listed here, and refer to the [wiki] for the
-documentation.
+Refer to the [wiki] for the usage/documentation.
+
+* [f7_app]
+* [f7_views]
+* [f7_view]
+* [f7_navbar]
+* [f7_pages]
+* [f7_page]
 
 ## Future Improvements
 
-Currently, the gem only brings in the assets. But it is the intention to add
-layout/view generators and helpers.
+In the immediate future we'd like to:
+
+* Make the code a bit more DRY.
+* Move all the grunt work out of the helpers, into Presenters/Decorators.
+* Add javascript generation for the more dynamic elements.
 
 ## Contributing
 
-1. Fork it ( http://github.com/twss/framework7-rails/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Fork it [http://github.com/twss/framework7-rails/fork](http://github.com/twss/framework7-rails/fork).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create new Pull Request.
 
 
 [wiki]: https://github.com/twss/framework7-rails/wiki "wiki"
+[f7_app]: https://github.com/twss/framework7-rails/wiki/helpers/f7_app
+[f7_navbar]: https://github.com/twss/framework7-rails/wiki/helpers/f7_navbar
+[f7_page]: https://github.com/twss/framework7-rails/wiki/helpers/f7_page
+[f7_pages]: https://github.com/twss/framework7-rails/wiki/helpers/f7_pages
+[f7_view]: https://github.com/twss/framework7-rails/wiki/helpers/f7_view
+[f7_views]: https://github.com/twss/framework7-rails/wiki/helpers/f7_views

data/app/helpers/app_helper.rb

@@ -1,6 +1,6 @@
 module AppHelper
   # Provides the skeleton application layout ready to be customised
-  def f7_app(options={}, &block)
+  def f7_app(*args, &block)
     output = []
     output << statusbar_overlay_div
     output << panel_overlay_div

data/app/helpers/bar_helper.rb

@@ -0,0 +1,45 @@
+module BarHelper
+  
+  @f7_bartype = nil
+  @has_labels = false
+                            
+  def f7_navbar(html_options={}, &block)
+    @f7_bartype = :navbar
+    
+    html_options[:class] = ([html_options[:class]] || []) << @f7_bartype
+    
+    content_tag :div, html_options do
+      content_tag :div, :class => ['navbar-inner'] do
+        yield if block_given?
+      end
+    end
+  end
+  
+  def f7_toolbar(options={}, &block)
+    @f7_bartype = :toolbar
+    css_classes = []
+    css_classes << @f7_bartype
+    css_classes += [options[:class]] if options[:class]
+    css_classes.flatten!
+
+    @f7_bartype = :tabbar if options[:type].to_s.include?('tabbar')
+
+    if @f7_bartype == :tabbar
+      css_classes << 'tabbar'
+      if options[:type] == :tabbar_labels
+        css_classes << 'tabbar-labels'
+        @has_labels = true
+      end
+    end
+    options[:class] = css_classes
+    div_options = options.reject { |k, v| [:type].include? k }
+
+    content_tag :div, div_options do
+      content_tag :div, :class => ['toolbar-inner'] do
+        yield if block_given?
+      end
+
+    end
+  end
+
+end

data/app/helpers/bar_item_helper.rb

@@ -0,0 +1,105 @@
+module BarItemHelper
+
+  def f7_bar_item(title_or_options, options=nil, &block)
+    output = []
+    if title_or_options.class == Hash
+      options = title_or_options
+      title = options[:title]
+    else
+      title = title_or_options
+      options ||= {}
+      options[:title] = title
+    end
+
+    position = (options[:position] || :left) unless @f7_bartype == :tabbar
+    transition = options[:tansition]
+
+    css_classes = []
+    css_classes << position
+    css_classes << [transition].flatten if options[:transition]
+    options[:class] = ([options[:class]] || []) + css_classes
+
+    html_options = options.reject { |k, v| [:position, :title].include? k }
+
+    if block_given?
+      output << capture(&block)
+    else
+      if options[:href]
+        link_options =  options.select { |k, v| [:title, :href, :icon, :badge].include? k.to_sym }
+        output << f7_bar_link(link_options)
+      else
+        output << title
+      end
+    end
+
+    if @f7_bartype == :tabbar
+      output.join("\n").html_safe
+    else
+      content_tag :div, :class => css_classes do
+        output.join("\n").html_safe
+      end
+    end
+  end
+
+  def f7_bar_link(title_or_options, options=nil)
+    output = []
+    link_classes = []
+
+    if title_or_options.class == Hash
+      options = title_or_options
+      title = options[:title]
+    else
+      title = title_or_options
+      options ||= {}
+    end
+
+    href = options[:href] || '#'
+    icon = options[:icon]
+
+    if @f7_bartype == :tabbar
+      link_classes << 'tab-link'
+    else
+      link_classes << :link
+    end
+
+    link_classes << 'icon-only' if title.blank? 
+    options[:class] = ([options[:class]] || []) + link_classes
+
+    link_attr = options.reject { |k, v| [:title, :icon, :badge].include? k }
+
+    span_class = (@f7_bartype == :tabbar ? {:class => 'tabbar-label'} : nil)
+
+    if icon.blank?
+      content_tag :a, title, link_attr
+    else
+      badge = nil
+      link_options = {}
+      if @f7_bartype == :tabbar
+        if options[:badge].kind_of? Hash
+          badge_data = options[:badge]
+          badge_classes = [:badge]
+          badge_classes << badge_data[:class] unless badge_data[:class].blank?
+          badge = content_tag :span, badge_data[:text], :class => badge_classes
+        else
+          badge = content_tag :span, options[:badge], :class => [:badge, 'badge-red']
+        end
+        link = link_icon_i(options[:icon], badge)
+      end
+      puts " has labels: #{@has_labels ? 'true' : 'false'}"
+      content_tag :a, :href => href, :class => link_classes do
+        output << link_icon_i(options[:icon], badge)
+        output << content_tag(:span, title, span_class) if !title.blank? && @has_labels
+        output.join("\n").html_safe
+      end
+    end
+  end
+
+  private
+
+  def link_icon_i(icon)
+    if icon
+      content_tag :i, '', :class => ['icon', icon]
+    end
+  end
+
+end

data/app/helpers/content_block_helper.rb

@@ -0,0 +1,66 @@
+module ContentBlockHelper
+
+  def f7_content_block(*args, &block)
+    output = []
+    title = nil
+    options = {}
+    if args.count > 0
+      if (args.first.kind_of?(String) || args.first.kind_of?(Symbol))
+        title = args.first
+        options = args.second || {}
+      elsif arg.first.kind_of? Hash
+        options = args.first
+        title = options[:title]
+        options = options.reject { |k,v| k == :title }
+      end
+    end
+    output << content_block_title_div(title) unless title.nil?
+    output << content_block_div(options) do
+      yield if block_given?
+    end
+    output.join("\n").html_safe
+  end
+
+
+
+  private
+
+  def content_block_div(options, &block)
+    format = []
+    output = []
+    css_classes = []
+    css_classes << "content-block"
+
+    if options[:format]
+      format = [options[:format]].flatten!.map { |v| v.to_sym }
+      if format.include? :inset
+        css_classes << "inset"
+      elsif format.include? :tablet_inset
+        css_classes << "tablet-inset"
+      end
+    end
+    css_classes += [options[:class]] if options[:class]
+
+    options.reject! { |k, v| [:class, :format].include? k }
+    options[:class] = css_classes.uniq
+
+    content_tag :div, options do
+      if format.include? :inner
+        content_tag :div, :class => [ 'content-block-inner' ] do
+          output << capture(&block) if block_given?
+          output.join("\n").html_safe
+        end
+      else
+        output << capture(&block) if block_given?
+        output.join("\n").html_safe
+      end
+    end
+  end
+
+
+
+  def content_block_title_div(title)
+    content_tag :div, title, :class => [ 'content-block-title' ]
+  end
+
+end

data/app/helpers/framework7_helper.rb

@@ -0,0 +1,26 @@
+module Framework7Helper
+  def present(object, klass = nil)
+    klass ||= "#{object.class}Presenter".constantize if Rails.const_defined?("#{object.class}Presenter")
+    klass ||= "Framework7::#{object.class.name.demodulize}Presenter".constantize
+    presenter = klass.new(object, self)
+    yield presenter if block_given?
+    presenter
+  end
+
+  # def f7_link(name = nil, options = nil, html_options = nil, &block)
+  #   if name.blank?
+  #     if html_options[:class]
+  #       html_options[:class] = ['link', 'icon-only'].merge!(html_options[:class])
+  #     else
+  #       html_options[:class] = ['link', 'icon-only']
+  #     end
+
+  #     if options[:icon]
+  #       icon = options[:icon]
+  #       name = content_tag(:i, '', :class => ['icon', "icon-#{icon}"])
+  #       options.reject! { |k, v| k == :icon }
+  #     end
+  #   else
+  #     link_to name, options, html_options, block
+  # end
+end

data/app/helpers/list_block_helper.rb

@@ -0,0 +1,180 @@
+module ListBlockHelper
+  
+  def f7_list_block(*args, &block)
+    output = []
+    title = nil
+    options = {}
+    if args.count > 0
+      if (args.first.kind_of?(String) || args.first.kind_of?(Symbol))
+        title = args.first
+        options = args.second || {}
+      elsif arg.first.kind_of? Hash
+        options = args.first
+        title = options[:title]
+        options = options.reject{ |k,v| k == :title }
+      end
+    end
+    list_block_div(options) do
+      concat content_block_title_div(title) unless title.blank?
+      concat list_block_ul(&block)
+      concat list_block_label(options) unless options[:label].blank?
+    end
+  end
+  
+  
+  def f7_list_divider(title_or_options, options = nil, &block)
+    if title_or_options.class == Hash
+      options = title_or_options if options.nil?
+      title_or_options = options[:title]
+    end
+    title = title_or_options
+
+    content_tag :li do
+      content_tag :div, title, :class => ['item-divider']
+    end
+  end
+  
+  
+  
+  def f7_list_group(title_or_options, options = nil, &block)
+    if title_or_options.class == Hash
+      options = title_or_options if options.nil?
+      title_or_options = options[:title]
+    end
+    title = title_or_options
+
+    content_tag :div, :class => ["list-group"] do
+      concat list_group_title title unless title.blank?
+      yield if block_given?
+    end
+  end
+  
+  
+  def f7_list_group_title(title, options = {}, &block)
+    list_group_li(title, options)
+  end
+  
+  
+  
+  def f7_list_item(title, options = {}, &block)
+    content_tag :li do
+      css_classes = ["item-content"]
+      tag = options[:href] ? :a : :div
+      css_classes << "item-link" if tag == :a
+      css_classes.concat(options[:class]) if options[:class]
+      
+      tag_options = options.reject { |k, v| [:title, :icon, :after].include? k }
+      tag_options[:class] = css_classes
+      
+      content_tag tag, tag_options do
+        concat list_icon_i(options[:icon]) if options[:icon]
+        concat list_item_inner(title, options)
+      end
+    end
+  end  
+  
+  
+  
+  private
+  
+  def list_block_div(options={}, &block)
+    output = []
+    css_classes = ["list-block"]
+    if options[:format]
+      format = [options[:format]].flatten.map { |v| v.to_sym }
+      if format.include? :inset
+        css_classes << "inset"
+      elsif format.include? :tablet_inset
+        css_classes << "tablet-inset"
+      end
+    end
+    css_classes += [options[:class]] if options[:class]
+    
+    block_options = options.reject { |k, v| [:class, :format, :label].include? k }
+    block_options[:class] = css_classes.uniq
+    
+    content_tag :div, block_options do
+      output << capture(&block) if block_given?
+      output.join("\n").html_safe
+    end
+  end
+  
+  
+  
+  def list_block_ul(&block)
+    content_tag :ul do
+      yield if block_given?
+    end
+  end
+  
+  
+  
+  def list_group_title(title, options={})
+    content_tag :li, title, :class => ["list-group-title"]
+  end
+  
+  
+  
+  def list_item_inner(title, options={})
+    content_tag :div, :class => ["item-inner"] do
+      concat content_tag :div, title, :class => ["item-title"]
+      concat list_item_inner_div(options)
+    end
+  end
+  
+  
+  
+  def list_item_inner_div(options={}, &block)
+    if options[:after] || options[:badge]
+      content_tag :div, :class => ['item-after'] do
+        if options[:after]
+          if options[:after].kind_of? Hash
+            after = options[:after].first
+            case after[0].to_sym
+            when :icon
+              klass = "icon #{after[1]}"
+              concat content_tag(:span, '', :class => klass)
+            when :badge
+              badge_or_options = after[1]
+              if badge_or_options.kind_of? Hash
+                badge_data = badge_or_options
+                badge_classes = [:badge]
+                badge_classes << badge_data[:class] unless badge_data[:class].blank?
+                badge = content_tag :span, badge_data[:text], :class => badge_classes
+              else
+                badge = content_tag :span, badge_or_options, :class => [:badge, 'badge-red']
+              end
+            when :text
+              concat after[1]
+            end
+          else
+            concat "#{options[:after]}"
+          end
+        end
+      end
+    end
+  end
+  
+  
+  
+  def list_item_badge(value, options={})
+    content_tag :span, value, :class => ["badge"]
+  end
+  
+  
+  
+  def list_icon_i(icon)
+    content_tag :div, :class => ['item-media'] do
+      content_tag :i, '', :class => ['icon', icon]
+    end
+  end
+  
+  
+  
+  def list_block_label(options={}, &block)
+    content_tag :div, :class => "list-block-label" do
+      content_tag :p, options[:label] if options[:label]
+    end
+  end
+  
+end