chr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 041ba212dd13b510084036d1bc6612a42cb48d78
+  data.tar.gz: f61e509e945fde982a8ed4c98bd859a09e7e989e
+SHA512:
+  metadata.gz: 6acf539bd041adb2c19902af2244caa8f7994726e98c0006fa1f9834daa0ce5cc2f2b8d53ceff1d50c6c0d2cccc1d13e06c9c1adb09d4af79a29f6b195b1aa9f
+  data.tar.gz: 7ce77b17204fcb13bd95c76a5abd26afe740a082dc6d1bee0f9db760cdc2421ccd2d70a883123b224138917163031232bdebfafbeb2e56ffceaf695ed55c4e7d

data/.gitignore

@@ -0,0 +1,7 @@
+_site
+.DS_store
+.sass-cache
+*gem
+*swp
+Gemfile.lock
+tmp

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+We love pull requests. Here’s a quick guide:
+
+1. Fork the repository.
+2. Make your changes in a topic branch.
+3. Squash your commits into a single one (more on that [here](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)).
+4. Rebase against `origin/master`, push to your fork and submit a pull request.
+5. If you are writing a new feature please add documentation for it by making another pull request to the `gh-pages` branch.
+
+At this point you’re waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Fix a bug, refactor code or expand an existing feature.
+* Use the right syntax and naming conventions.
+* Update parts of the documentation that are affected by your contribution.
+
+**Git Commit Messages**
+
+* Capitalize your commit messages.
+* Start your message with a verb.
+* Use present tense.
+* Refer to the issue/PR number in your squashed commit message.

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2015 [slatestudio, inc.](http://slatestudio.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+# Character
+
+## A simple and lightweight library for building data management web apps
+
+## The Character family
+
+- [Mongosteen](https://github.com/slate-studio/mongosteen): An easy way to add restful actions
+- [Character Admin](https://github.com/slate-studio/chr-admin): Flexible javascript admin solution for Rails applications
+
+## Credits
+
+[![Slate Studio](https://slate-git-images.s3-us-west-1.amazonaws.com/slate.png)](http://slatestudio.com)
+
+Character is maintained and funded by [Slate Studio, LLC](http://slatestudio.com). Tweet your questions or suggestions to [@slatestudio](https://twitter.com/slatestudio) and while you’re at it follow us too.
+
+## License
+
+Copyright © 2015 [Slate Studio, LLC](http://slatestudio.com). Character is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).

data/Rakefile

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require "rubygems"
+require "bundler"

data/app/assets/javascripts/chr.coffee

@@ -0,0 +1,41 @@
+#= require jquery
+#= require jquery_ujs
+#= require ./chr/vendor/jquery.scrollparent
+#= require ./chr/vendor/jquery.textarea_autosize
+#= require ./chr/vendor/jquery.typeahead
+#= require ./chr/vendor/slip
+
+#= require ./chr/core/_item
+#= require ./chr/core/_list
+#= require ./chr/core/_listSearch
+#= require ./chr/core/_listScroll
+#= require ./chr/core/_listReorder
+#= require ./chr/core/_view
+#= require ./chr/core/_module
+
+#= require ./chr/form/_form
+#= require ./chr/form/_inputString
+#= require ./chr/form/_inputCheckbox
+#= require ./chr/form/_inputColor
+#= require ./chr/form/_inputFile
+#= require ./chr/form/_inputHidden
+#= require ./chr/form/_inputList
+#= require ./chr/form/_inputSelect
+#= require ./chr/form/_inputText
+#= require ./chr/form/_nestedForm
+
+#= require ./chr/store/_store
+#= require ./chr/store/_storeRails
+
+#= require ./chr/core/_utils
+#= require ./chr/core/_chr
+
+# -------------------------------------
+# Settings
+# -------------------------------------
+$.fx.speeds._default = 200
+
+
+
+
+

data/app/assets/javascripts/chr/core/_chr.coffee

@@ -0,0 +1,89 @@
+# -----------------------------------------------------------------------------
+# Character
+# -----------------------------------------------------------------------------
+class @Chr
+  constructor: (@config) ->
+    @modules = {}
+
+    @$el       =$ (@config.selector ? 'body')
+    @$navBar   =$ "<nav class='sidebar'>"
+    @$mainMenu =$ "<div class='menu'>"
+
+    @$navBar.append @$mainMenu
+    @$el.append @$navBar
+
+    @modules[name] = new Module(this, name, config) for name, config of @config.modules
+
+    # NAVIGATION
+    # using class 'silent' for links when we don't want to trigger onhashchange event
+    $(document).on 'click', 'a.silent', (e) -> window._skipHashchange = true
+
+    window.onhashchange = =>
+      if not window._skipHashchange then @_navigate(location.hash)
+      window._skipHashchange = false
+
+    # if not mobile navigate on first page load or page refresh
+    if not _isMobile()
+      window._skipHashchange = false
+      @_navigate(if location.hash != '' then location.hash else '#/' + Object.keys(@modules)[0])
+
+  addMenuItem: (moduleName, title) ->
+    @$mainMenu.append "<a href='#/#{ moduleName }'>#{ title }</a>"
+
+  selectMenuItem: (href) ->
+    @$mainMenu.children().removeClass 'active'
+    @$mainMenu.children("a[href='#/#{ href }']").addClass 'active'
+
+  unselectMenuItem: ->
+    @$mainMenu.children().removeClass 'active'
+
+  # TODO: this piece of navigation code isn't clear, need to refactor to make
+  #       it more readable
+  _navigate: (path) ->
+    # #/<module>[/<list>][/new]OR[/view/<objectId>]
+    crumbs = path.split('/')
+
+    @unselectMenuItem()
+
+    # if module changed, hide previous module
+    if @module != @modules[crumbs[1]]
+      @module?.hide((path == '#/')) # NOTE: animate only for root path
+
+    @module = @modules[crumbs[1]] # module name on position 1
+
+    if @module
+      @module.show()
+
+      config = @module.config
+      crumbs = crumbs.splice(2) # remove #/<module> part
+
+      if crumbs.length > 0
+        for crumb in crumbs
+          if crumb == 'new'
+            # TODO: reset list data
+            return @module.showView(null, config, 'New')
+
+          if crumb == 'view'
+            objectId = _last(crumbs)
+            return @module.showViewWhenObjectsAreReady(objectId, config)
+
+          config = config.items[crumb]
+
+          if config.objectStore
+            # TODO: check if object is loaded and if it's not load it first
+            object = $.extend({ _id: crumb }, config.objectStore.get())
+            return @module.showView(object, config, crumb.titleize())
+
+          else
+            @module.showNestedList(crumb)
+      else
+        # NOTE: show module root list for the case when same module picked
+        @module.destroyView()
+        while @module.activeList != @module.rootList
+          @module.hideActiveList(false)
+
+
+
+
+
+

data/app/assets/javascripts/chr/core/_item.coffee

@@ -0,0 +1,85 @@
+# -----------------------------------------------------------------------------
+# ITEM
+# -----------------------------------------------------------------------------
+class @Item
+  _isFolder: ->
+    # TODO: update this logic as it's not reliable
+    if @object._title then true else false
+
+  _renderTitle: ->
+    title  = @object._title # nested list title predefined in config (or slug based)
+    title ?= @object[@config.itemTitleField] # based on config
+    title ?= _firstNonEmptyValue(@object) # auto-generated: first non empty value
+    title ?= "No Title"
+    title  = _stripHtml(title)
+
+    @$title =$ "<div class='item-title'>#{title}</div>"
+    @$el.append(@$title)
+    @$el.attr  'data-title', title
+
+  _renderSubtitle: ->
+    if @config.itemSubtitleField
+      subtitle   = @object[@config.itemSubtitleField]
+      if subtitle != ''
+        @$subtitle =$ "<div class='item-subtitle'>#{subtitle}</div>"
+        @$el.append(@$subtitle)
+        @$el.addClass 'has-subtitle'
+
+  _renderThumbnail: ->
+    if @config.itemThumbnail
+      imageUrl = @config.itemThumbnail(@object)
+      if imageUrl != '' and not imageUrl.endsWith('_old_') # NOTE: carrierwave fix
+        @$thumbnail =$ "<div class='item-thumbnail'><img src='#{imageUrl}' /></div>"
+        @$el.append(@$thumbnail)
+        @$el.addClass 'has-thumbnail'
+
+  render: ->
+    @$el.html('').removeClass('item-folder has-subtitle has-thumbnail')
+    @_renderTitle()
+
+    if @_isFolder()
+      @$el.addClass('item-folder')
+      @$el.append $("<div class='icon-folder'></div>")
+    else
+      @_renderSubtitle()
+      @_renderThumbnail()
+
+      if @config.arrayStore and @config.arrayStore.reorderable
+        @$el.addClass('reorderable')
+        @$el.append $("<div class='icon-reorder'></div>")
+
+  constructor: (@module, @path, @object, @config) ->
+    @$el =$ """<a class='item silent' href='#{ @path }' data-id='#{ @object._id }' data-title=''></a>"""
+    @$el.on 'click', (e) => @onClick(e)
+    @render()
+
+  onClick: (e) ->
+    window._skipHashchange = true
+    location.hash = $(e.currentTarget).attr('href')
+
+    title  = $(e.currentTarget).attr('data-title')
+    id     = $(e.currentTarget).attr('data-id')
+    crumbs = location.href.split('/')
+
+    if @config.arrayStore and crumbs[crumbs.length - 2] == 'view'
+      object = @config.arrayStore.get(id)
+
+    if @config.objectStore
+      object = @config.objectStore.get()
+
+    if object
+      return @module.showView(object, @config, title, true)
+
+    @module.showNestedList(_last(crumbs), true)
+
+  destroy: ->
+    @$el.remove()
+
+  position: ->
+    fieldName = @config.arrayStore.sortBy
+    @object[fieldName]
+
+
+
+
+

data/app/assets/javascripts/chr/core/_list.coffee

@@ -0,0 +1,154 @@
+# -----------------------------------------------------------------------------
+# LIST
+# -----------------------------------------------------------------------------
+class @List
+  _loading: (callback) ->
+    @$el.addClass 'list-loading'
+    callback()
+
+  _path: ->
+    crumbs = [] ; l = this
+    while l.parentList
+      crumbs.push(l.name) ; l = l.parentList
+    @module.name + ( if crumbs.length > 0 then '/' + crumbs.reverse().join('/') else '' )
+
+  _updateItemPosition: (item, position) ->
+    position = @configItemsCount + position
+    if position == 0
+      @$items.prepend(item.$el)
+    else
+      @$items.append(item.$el.hide())
+      $(@$items.children()[position - 1]).after(item.$el.show())
+
+  _addItem: (path, object, position, config) ->
+    item = new Item(@module, path, object, config)
+    @items[object._id] = item
+    @_updateItemPosition(item, position)
+
+  _processConfigItems: ->
+    for slug, config of @config.items
+      object = { _id: slug, _title: config.title ? slug.titleize() }
+
+      if config.objectStore
+        $.extend(object, config.objectStore.get())
+
+      if config.items or config.arrayStore
+        @module.addNestedList(slug, config, this)
+
+      @_addItem("#/#{ @path }/#{ slug }", object, 0, config)
+      @configItemsCount += 1
+
+  _bindConfigObjectStore: ->
+
+  _bindConfigArrayStore: ->
+
+    # NOTE: starts data fetch
+    @config.arrayStore.on 'object_added', (e, data) =>
+      @_addItem("#/#{ @path }/view/#{ data.object._id }", data.object, data.position, @config)
+      data.callback?(data.object)
+
+    @config.arrayStore.on 'object_changed', (e, data) =>
+      item = @items[data.object._id]
+      item.render()
+      @_updateItemPosition(item, data.position)
+      data.callback?(data.object)
+
+    @config.arrayStore.on 'object_removed', (e, data) =>
+      @items[data.object_id].destroy()
+      delete @items[data.object_id]
+
+    @config.arrayStore.on 'objects_added', (e, data) =>
+      @$el.removeClass 'list-loading'
+
+    if @config.arrayStore.pagination
+      _listBindScroll(this)
+
+    if @config.arrayStore.searchable
+      _listBindSearch(this)
+
+    if @config.arrayStore.reorderable
+      _listBindReorder(this)
+
+  constructor: (@module, @name, @config, @parentList) ->
+    @configItemsCount = 0
+    @path  = @_path()
+    @items = {}
+    @title = @config.title ? @name.titleize()
+
+    @$el =$ "<div class='list #{ @name }'>"
+    @module.$el.append @$el
+
+    if @parentList then @$el.hide() # hide all nested lists
+
+    @$items =$ "<div class='items'>"
+    @$el.append @$items
+
+    @$header =$ "<header></header>"
+
+    if @parentList
+      # NOTE: show back button for nested list
+      @parentListPath = @parentList.path
+      @$backBtn =$ "<a href='#/#{ @parentListPath }' class='back silent'></a>"
+      @$backBtn.on 'click', (e) => @onBack(e)
+      @$header.prepend @$backBtn
+    else
+      @$backBtn =$ "<a href='#/' class='back'></a>"
+      @$header.prepend @$backBtn
+
+
+    @$header.append "<span class='title'>#{ @title }</span>"
+
+    if not @config.disableNewItems and @config.formSchema
+      @$newBtn =$ "<a href='#/#{ @path }/new' class='new silent'></a>"
+      @$newBtn.on 'click', (e) => @onNew(e)
+      @$header.append @$newBtn
+
+    @$search =$ """<div class='search' style='display: none;'>
+                     <a href='#' class='icon'></a>
+                     <input type='text' placeholder='Search...' />
+                     <a href='#' class='cancel'>Cancel</a>
+                   </div>"""
+    @$header.append @$search
+
+    @$el.append @$header
+
+    if @config.items       then @_processConfigItems()
+    if @config.arrayStore  then @_bindConfigArrayStore()
+    if @config.objectStore then @_bindConfigObjectStore()
+
+  selectItem: (href) ->
+    @$items.children("a[href='#{ href }']").addClass 'active'
+
+  unselectItems: ->
+    @$items.children().removeClass 'active'
+
+  hide: ->
+    @unselectItems()
+    @$el.hide()
+
+  show: (animate=false) ->
+    if animate
+      @$el.fadeIn()
+    else
+      @$el.show()
+
+  onBack: (e) ->
+    @unselectItems()
+    @module.hideActiveList(true)
+    @module.destroyView()
+
+  onNew: (e) ->
+    window._skipHashchange = true
+    location.hash = $(e.currentTarget).attr('href')
+    @module.showView(null, @config, 'New', true)
+
+  updateItems: (callback) ->
+    if not @config.disableReset
+      if @config.arrayStore
+        @_loading => @config.arrayStore.reset(callback)
+
+  isVisible: ->
+    @$el.is(':visible')
+
+
+