meta2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa433e368bef30a9d9fc9e8017952c5fab25a64a
-  data.tar.gz: df9a8784fcab09b85c43e76da1a2d0ac07746901
+  metadata.gz: e4b44cc106dc7ebd8eb9a2f52ddbecde5f5b9a2c
+  data.tar.gz: 6aeb1d5d6191ee6f59f8b83bda8f3579c0174b81
 SHA512:
-  metadata.gz: de362c12a7156c2f1e6545cadfa23896b7c78c37b018bd7600dca84684861904c3943100d12380bf2c9080a7a3f821320664164480c2b7a5456a5d11c17bff39
-  data.tar.gz: 1f8828e55628da1bcf2c674cbc82e9b2df936170ff2a2fc1724b1fea8c9c80b9331726ab6c0ecfc08f0f6ff2066036c99350f55194287c77fe9a347bc4bd0cbe
+  metadata.gz: 522e6f1921c285a90cd25a19fb09542edec115ff77fda7049f4150afbde71d235a004ce4585494315f6c159beb7cd001d55623f85f842e0910898ca673d5c2cf
+  data.tar.gz: 5df81c838ea6c05601479e7a94a65713b02622510d93f88ce3ebe012cbfbea8951ce9fef1953714bee9237eabbc453a014ba6d8457cf99a3fddfa4d3b38d04a8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    meta2 (0.0.1)
+    meta2 (0.0.2)
       activesupport (>= 4.0.0, < 5)
       i18n (~> 0.7.0)
 

data/README.md

@@ -1,6 +1,6 @@
 # Meta2
 
-TODO: Write a gem description
+Implementation of the order to easily manage the meta-information for engineers and service managers. When your write i18n file or manage database through active record, put on it is reflected meta information on html.
 
 ## Installation
 
@@ -18,9 +18,47 @@ Or install it yourself as:
 
     $ gem install meta2
 
-## Usage
+## Features ##
+
+1. Minimize the number of issued of SQL for system load usisng active record strategy.
+2. Implement scafoiding of the management function.
+
+
+## Supported ORMs. ##
+
+Active record only.
+
+
+## Usage ##
+
+1. bundle 'meta2' gem.
+2. Create setting file for `meta2` by install command. You can use the generator for doing this ( `% rails g meta2:install` ) Setting file is created ( `config/initializers/meta2.rb` ).
+3. Basically there is not problem with default setting, if you need to change it, Plrease change in the reference of `Setting` section.
+4. Writing helper method for meta2 ( `meta_tags` ) into html head tag.
+5. Please configure the meta-information according strategry your choice for each page on your system.
+6. Then it's done.
+
+## Setting ##
+
+* strategy
+You can choise `:i18n` or `:activerecord` as the storage for saving meta information. default, `i18n`.
+
+* assign_name
+Default `meta2`. Basically you do not need to change.
+
+* columns
+Default `title`, `description` and `keyword`.
+
+* logger
+
+*logging
+
+## Configuration ##
+
+### I18n ###
+
+### Active record ###
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/app/assets/javascripts/meta2/activerecord-manager.js

@@ -0,0 +1,6 @@
+$(function() {
+  $('#meta2_activerecord_section_selecter').on('change', function() {
+    var rpath = $(this).data('path') + '?section=' + $(this).val();
+    location.href = rpath;
+  });
+});

data/app/controllers/meta2/settings_controller.rb

@@ -0,0 +1,91 @@
+module Meta2
+  class SettingsController < Meta2.config.controller_base.constantize
+    helper Meta2::ApplicationHelper
+    helper_method :app_name_from_session
+
+    before_action :activerecord_strategy?
+    before_action :set_setting, only: [:edit, :update, :destroy]
+
+    def index
+      if settings_base.blank?
+        redirect_to new_setting_path and return
+      end
+
+      @settings = settings_base.target_sections params[:section]
+      @settings = @settings.page(params[:page]).per(Meta2.config.per_for_paginate)
+    end
+
+    def new
+      @setting = settings_base.new app_name: app_name_from_session
+    end
+
+    def create
+      @setting = settings_base.new setting_params
+      if @setting.valid?(:pre_check) && @setting.save(context: @setting.section.to_sym)
+        session[Meta2.config.session_name] = @setting.app_name
+        redirect_to edit_setting_path(@setting), notice: I18n.t('meta2.setting.message.created')
+      else
+        render :new
+      end
+    end
+
+    def edit
+    end
+
+    def update
+      @setting.attributes = setting_params
+      if @setting.valid?(:pre_check) && @setting.save(context: @setting.section.to_sym)
+        redirect_to edit_setting_path(@setting), notice: I18n.t('meta2.setting.message.updated')
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      if %w(formats defaults).include? @setting.section
+        redirect_to settings_path, alert: I18n.t('meta2.setting.message.not_destroy') and return
+      end
+
+      @setting.destroy
+      redirect_to settings_path, notice: I18n.t('meta2.setting.message.destroyed')
+    end
+
+    def change_app
+      setting = Setting.find_by app_name: params[:app_name]
+      if setting.blank?
+        not_found and return
+      end
+
+      session[Meta2.config.session_name] = params[:app_name]
+
+      redirect_to settings_path
+    end
+
+
+    private
+
+    def set_setting
+      @setting = settings_base.find_by id: params[:id]
+      not_found if @setting.blank?
+    end
+
+    def setting_params
+      params.required(:setting).permit(:app_name, :section, :path, :name, :value, :note)
+    end
+
+    def settings_base
+      Setting.by_app_name app_name_from_session
+    end
+
+    def app_name_from_session
+      session[Meta2.config.session_name].presence || 'meta2'
+    end
+
+    def activerecord_strategy?
+      unless :active_record == Meta2.config.strategy.to_sym
+        Meta2.debug I18n.t('meta2.setting.message.activerecord_limited')
+        raise I18n.t('meta2.setting.message.activerecord_limited')
+      end
+    end
+  end
+end

data/app/helpers/meta2/application_helper.rb

@@ -0,0 +1,8 @@
+module Meta2
+  module ApplicationHelper
+    def options_of_section_from_meta2_settings_for_select(form)
+      options = I18n.t('meta2.setting.sections').to_hash.invert
+      options_for_select options, selected: form.object.section.to_s
+    end
+  end
+end

data/app/models/meta2/setting.rb

@@ -0,0 +1,68 @@
+module Meta2
+  class Setting < ActiveRecord::Base
+    with_options on: :pre_check do
+      validates :section, presence: true, inclusion: { in: Meta2.config.sections }
+    end
+
+    with_options on: :formats do
+      validates :app_name,  presence: true, uniqueness: {scope: [:section, :path, :name]}
+      validates :name,      presence: true
+      validates :value,     presence: true, format: {with: /\A.*\%.*\Z/i, message: I18n.t('meta2.setting.message.incorrect_format_for_formats_value')}
+    end
+
+    with_options on: :defaults do
+      validates :app_name,  presence: true, uniqueness: {scope: [:section, :path, :name]}
+      validates :name,      presence: true
+      validates :value,     presence: true
+    end
+
+    with_options on: :parts do
+      validates :app_name,  presence: true, uniqueness: {scope: [:section, :path, :name]}
+      validates :path,      presence: true
+      validates :name,      presence: true
+      validates :value,     presence: true
+    end
+
+
+    scope :by_app_name, ->(app_name) {
+      where app_name: app_name
+    }
+
+    scope :target_sections, ->(section_name) {
+      section_name = 'parts' if section_name.blank?
+      return unless self.sections.include? section_name
+      send section_name
+    }
+
+    scope :formats, -> {
+      where section: 'formats'
+    }
+
+    scope :defaults, -> {
+      where section: 'defaults'
+    }
+
+    scope :parts, -> {
+      where section: 'parts'
+    }
+
+    def method_missing(method, *args)
+      check_name = method.to_s.gsub '?', ''
+      unless %w(formats defaults parts).include? check_name
+        super(method, args) and return
+      end
+
+      self.section == check_name
+    end
+
+    class << self
+      def app_names
+        self.group(:app_name).pluck :app_name
+      end
+
+      def sections
+        Meta2.config.sections
+      end
+    end
+  end
+end

data/app/views/meta2/settings/_form.html.slim

@@ -0,0 +1,40 @@
+= form_for @setting, html: {class: 'form-horizontal'} do |form|
+
+  - if form.object.errors.any?
+    ul.list-unstyled.alert.alert-danger
+      - form.object.errors.full_messages.each do |message|
+        li = message
+
+  .form-group
+    label.col-xs-2.control-label = Meta2::Setting.human_attribute_name :app_name
+    .col-xs-10
+      = form.text_field :app_name, class: 'form-control', disabled: form.object.persisted?
+
+  .form-group
+    label.col-xs-2.control-label = Meta2::Setting.human_attribute_name :section
+    .col-xs-10
+      = form.select :section, options_of_section_from_meta2_settings_for_select(form), {}, class: 'form-control', disabled: form.object.persisted?
+
+  .form-group
+    label.col-xs-2.control-label = Meta2::Setting.human_attribute_name :path
+    .col-xs-10
+      = form.text_field :path, class: 'form-control', disabled: (form.object.persisted? && !form.object.parts?)
+
+  .form-group
+    label.col-xs-2.control-label = Meta2::Setting.human_attribute_name :name
+    .col-xs-10
+      = form.select :name, options_for_select(I18n.t('meta2.setting.defaults').invert, selected: form.object.name), {}, class: 'form-control', disabled: form.object.persisted?
+
+  .form-group
+    label.col-xs-2.control-label = Meta2::Setting.human_attribute_name :value
+    .col-xs-10
+      = form.text_field :value, class: 'form-control'
+
+  .form-group
+    label.col-xs-2.control-label = Meta2::Setting.human_attribute_name :note
+    .col-xs-10
+      = form.text_field :note, class: 'form-control'
+
+  .form-group
+    .col-xs-10.col-xs-offset-2
+      = form.submit I18n.t('meta2.setting.submit'), class: 'btn btn-warning'

data/app/views/meta2/settings/_record.html.slim

@@ -0,0 +1,10 @@
+tr
+  td.text-center  = record.section
+  td              = record.path
+  td              = record.name
+  td              = record.value
+  td              = record.note
+  td.text-center
+    .btn-group
+      = link_to I18n.t('meta2.setting.edit'), edit_setting_path(record), class: 'btn btn-default'
+      = link_to I18n.t('meta2.setting.destroy'), setting_path(record), class: 'btn btn-default', method: :delete, data: {confirm: I18n.t('meta2.setting.message.destroy')}

data/app/views/meta2/settings/edit.html.slim

@@ -0,0 +1,6 @@
+.page-header
+  h1
+    span.pull-right = I18n.t 'meta2.setting.edit', name: cm('meta2/setting')
+    small = link_to 'Back', settings_path(section: @setting.section), class: 'btn btn-default btn-sm'
+
+= render 'form'

data/app/views/meta2/settings/index.html.slim

@@ -0,0 +1,19 @@
+.page-header
+  h1
+    span = "#{Meta2::Setting.model_name.human}管理"
+    small.pull-right = link_to I18n.t('meta2.setting.new'), new_setting_path(section: params[:section]), class: 'btn btn-default'
+
+ul.nav.nav-tabs
+  - Meta2::Setting.app_names.each do |app_name|
+    li role="presentation" class="#{'active' if app_name == app_name_from_session}" = link_to app_name, change_app_settings_path(app_name: app_name), method: :post
+
+
+table.table.table-borderd
+  tr
+    th = select_tag :section, options_for_select(I18n.t('meta2.setting.sections').to_hash.invert, selected: params[:section].presence || 'parts'), class: 'form-control', id: :meta2_activerecord_section_selecter, data: {path: settings_path}
+    th = cm 'meta2/setting.path'
+    th = cm 'meta2/setting.name'
+    th = cm 'meta2/setting.value'
+    th = cm 'meta2/setting.note'
+    th
+  = render partial: 'record', collection: @settings

data/app/views/meta2/settings/new.html.slim

@@ -0,0 +1,6 @@
+.page-header
+  h1
+    span.pull-right = I18n.t 'meta2.setting.new', name: Meta2::Setting.model_name.human
+    small = link_to 'Back', settings_path(section: params[:section]), class: 'btn btn-default btn-sm'
+
+= render 'form'

data/config/locales/meta2.ja.yml

@@ -0,0 +1,49 @@
+ja:
+  meta2:
+    setting:
+      new:      '新規作成'
+      edit:     '編集'
+      destroy:  '削除'
+      submit:   '送信する'
+      message:
+        created:    '新しい情報を作成しました'
+        updated:    '情報を更新しました'
+        destroyed:  '情報を削除しました'
+        destroy: |-
+          情報を削除しますか？
+          削除すると元に戻せません。
+        not_destroy: 'フォーマット、デフォルト値は削除出来ません'
+        incorrect_format_for_formats_value: 'フォーマットの値には"%"を含めてください'
+        activerecord_limited: 'Please choise `activerecord` strategy'
+      sections:
+        formats:  'フォーマット'
+        defaults: 'デフォルト'
+        parts:    'パーツ'
+      defaults:
+        title:        'タイトル'
+        description:  'デスクリプション'
+        keywords:     'キーワード'
+    config:
+      formats:
+        title:        '%'
+        description:  '%'
+      defaults:
+        title:        'タイトル'
+        description:  'デスクリプション'
+        keywords:     'キーワード'
+      sections:
+        welcome:
+          root:
+            title:        'Title for top page of your serivce.'
+            description:  'Description for top page of your service.'
+  activerecord:
+    models:
+      meta2/setting: 'メタ情報'
+    attributes:
+      meta2/setting:
+        app_name: 'アプリ識別'
+        section:  'セクション'
+        path:     'パス'
+        name:     '名前'
+        value:    '値'
+        note:     'メモ'

data/config/routes.rb

@@ -0,0 +1,7 @@
+Meta2::Engine.routes.draw do
+  resources :settings do
+    collection do
+      post 'change_app'
+    end
+  end
+end

data/lib/meta2/engine.rb

@@ -0,0 +1,5 @@
+module Meta2
+  class Engine < ::Rails::Engine
+    isolate_namespace Meta2
+  end
+end

data/lib/meta2/helpers/action_view_extension.rb

@@ -4,7 +4,14 @@ module Meta2
       def meta_tags
         resolver = instance_variable_get "@#{Meta2.config.assign_name}"
 
-        resolver.detect.to_html(resolver.context).html_safe
+        html_source = resolver.detect.to_html(resolver.context)
+        unless Rails.env.production?
+          asist_message = resolver.options[:prefixes].map do |prefix|
+            '%s.%s' % [prefix, resolver.options[:template]]
+          end.join "\n"
+          html_source += "<!--Meta2 path hinting.\n#{asist_message} -->\n"
+        end
+        html_source.html_safe
       end
     end
   end

data/lib/meta2/railtie.rb

@@ -4,11 +4,17 @@ module Meta2
 
     initializer 'meta2' do |app|
       config = app.config.meta2
-      config.strategy    = :i18n
-      config.assign_name = :meta2
-      config.columns     = %w{title description keywords}
-      config.logger      = Rails.logger
-      config.logging     = true
+
+      # Default settings. all subject can be changed.
+      config.strategy         = :i18n
+      config.assign_name      = :meta2
+      config.sections         = %w{formats defaults parts}
+      config.columns          = %w{title description keywords}
+      config.logger           = Rails.logger
+      config.logging          = true
+      config.controller_base  = 'ApplicationController'
+      config.per_for_paginate = 20
+      config.session_name     = '___current_meta2_app_name___'
     end
   end
 end

data/lib/meta2/strategies/active_record.rb

@@ -43,7 +43,7 @@ module Meta2
       end
 
       def targets
-        Meta2::Models::MetaSetting.where app_name: @config[:assign_name]
+        Meta2::Setting.where app_name: @config[:assign_name]
       end
     end
   end

data/lib/meta2/strategies/i18n.rb

@@ -28,7 +28,7 @@ module Meta2
       private
 
       def catch_path(namespace)
-        path = "#{@config.assign_name}.#{namespace}"
+        path = "#{@config.assign_name}.config.#{namespace}"
         Meta2.debug "#{namespace} path:#{path}"
         content = ::I18n.t path, default: FAILURE_KEYWORD
         FAILURE_KEYWORD == content.to_s ? nil : content

data/lib/meta2/strategies.rb

@@ -25,7 +25,7 @@ module Meta2
 
     def build_path(prefix)
       path_prefix = prefix.gsub '/', '.'
-      '%s.parts.%s.%s' % [
+      '%s.config.parts.%s.%s' % [
         @config.assign_name, path_prefix, @options[:template]
       ]
     end

data/lib/meta2/version.rb

@@ -1,3 +1,3 @@
 module Meta2
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/meta2.rb

@@ -1,4 +1,5 @@
 require 'active_support/dependencies'
+require 'meta2/engine'
 
 module Meta2
   autoload :Absorber,   'meta2/absorber'

data/meta2.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["manabu.oshiro"]
   spec.email         = ["manabu.oshiro@zinbun.com"]
   spec.summary       = %q{Implementation of the order to easily manage the meta-information.}
-  spec.description   = %q{Implementation of the order to easily manage the meta-information for enginners and service managers.}
+  spec.description   = %q{Implementation of the order to easily manage the meta-information for engineers and service managers. When your write i18n file or manage database through active record, put on it is reflected meta information on html.}
   spec.homepage      = "https://github.com/manoshiro/meta2"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meta2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - manabu.oshiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -87,7 +87,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 description: Implementation of the order to easily manage the meta-information for
-  enginners and service managers.
+  engineers and service managers. When your write i18n file or manage database through
+  active record, put on it is reflected meta information on html.
 email:
 - manabu.oshiro@zinbun.com
 executables: []
@@ -102,6 +103,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/javascripts/meta2/activerecord-manager.js
+- app/controllers/meta2/settings_controller.rb
+- app/helpers/meta2/application_helper.rb
+- app/models/meta2/setting.rb
+- app/views/meta2/settings/_form.html.slim
+- app/views/meta2/settings/_record.html.slim
+- app/views/meta2/settings/edit.html.slim
+- app/views/meta2/settings/index.html.slim
+- app/views/meta2/settings/new.html.slim
+- config/locales/meta2.ja.yml
+- config/routes.rb
 - lib/generators/active_record/meta2_generator.rb
 - lib/generators/active_record/templates/migration.rb
 - lib/generators/meta2/install_generator.rb
@@ -111,8 +123,8 @@ files:
 - lib/meta2.rb
 - lib/meta2/absorber.rb
 - lib/meta2/alias_method_chains.rb
+- lib/meta2/engine.rb
 - lib/meta2/helpers/action_view_extension.rb
-- lib/meta2/models/meta_setting.rb
 - lib/meta2/rails.rb
 - lib/meta2/railtie.rb
 - lib/meta2/resolver.rb

data/lib/meta2/models/meta_setting.rb

@@ -1,6 +0,0 @@
-module Meta2
-  module Models
-    class MetaSetting < ActiveRecord::Base
-    end
-  end
-end