[10.0][ADD] Module which provides a fiscal month date range type

account_fiscal_month/README.rst

@@ -0,0 +1,55 @@
+.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+   :alt: License: AGPL-3
+
+====================
+Account Fiscal Month
+====================
+
+This module simply provides a date range type marked as 'Fiscal month'.
+
+Installation
+============
+
+Just Install it.
+
+Configuration
+=============
+
+No configuration needed.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues
+<https://github.com/OCA/account-financial-tools/issues>`_. In case of trouble, please
+check there if your issue has already been reported. If you spotted it first,
+help us smashing it by providing a detailed and welcomed feedback.
+
+Credits
+=======
+
+Images
+------
+
+* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
+
+Contributors
+------------
+
+* Benjamin Willig <benjamin.willig@acsone.eu>
+
+Maintainer
+----------
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+This module is maintained by the OCA.
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+To contribute to this module, please visit https://odoo-community.org.

account_fiscal_month/__init__.py

@@ -0,0 +1 @@
+from . import models

account_fiscal_month/__manifest__.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    'name': 'Account Fiscal Month',
+    'summary': """
+        Provide a fiscal month date range type""",
+    'version': '10.0.1.0.0',
+    'license': 'AGPL-3',
+    'author': 'ACSONE SA/NV, Odoo Community Association (OCA)',
+    'website': 'https://www.acsone.eu',
+    'depends': [
+        'account',
+        'date_range',
+    ],
+    'data': [
+        'data/date_range_type.xml',
+        'views/date_range_type.xml',
+    ],
+}

account_fiscal_month/data/date_range_type.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2017 ACSONE SA/NV
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+
+<odoo noupdate="1">
+
+    <record model="date.range.type" id="date_range_fiscal_month">
+        <field name="name">Fiscal month</field>
+        <field name="allow_overlap" eval="False"/>
+        <field name="fiscal_month" eval="True"/>
+    </record>
+    
+</odoo>

account_fiscal_month/models/__init__.py

@@ -0,0 +1,2 @@
+from . import date_range_type
+from . import res_company

account_fiscal_month/models/date_range_type.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import api, fields, models, _
+from odoo.exceptions import UserError
+
+
+class DateRangeType(models.Model):
+
+    _inherit = 'date.range.type'
+
+    fiscal_month = fields.Boolean(string="Is fiscal month?", readonly=True)
+
+    @api.multi
+    def unlink(self):
+        date_range_type_fm = self.env.ref(
+            'account_fiscal_month.date_range_fiscal_month')
+        if date_range_type_fm.id in self.ids:
+            raise UserError(_("You can't delete date range type: "
+                              "Fiscal month"))
+        return super(DateRangeType, self).unlink()

account_fiscal_month/models/res_company.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import api, models
+
+
+class ResCompany(models.Model):
+
+    _inherit = 'res.company'
+
+    @api.multi
+    def find_daterange_fm(self, date_str):
+        self.ensure_one()
+        fm_id = self.env.ref('account_fiscal_month.date_range_fiscal_month')
+        return self.env['date.range'].search([
+            ('type_id', '=', fm_id.id),
+            ('date_start', '<=', date_str),
+            ('date_end', '>=', date_str),
+            ('company_id', '=', self.id),
+        ])

account_fiscal_month/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_account_fiscal_month

account_fiscal_month/tests/test_account_fiscal_month.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo.exceptions import UserError
+from odoo.fields import Date
+from odoo.tests.common import TransactionCase
+
+
+class TestAccountFiscalMonth(TransactionCase):
+
+    def setUp(self):
+        super(TestAccountFiscalMonth, self).setUp()
+        self.DateRangeObj = self.env['date.range']
+
+        self.company = self.env.ref('base.main_company')
+        self.date_range_type_month = self.env.ref(
+            'account_fiscal_month.date_range_fiscal_month')
+
+        self.date_range_january_2017 = self.DateRangeObj.create({
+            'name': "January 2017",
+            'date_start': '2017-01-01',
+            'date_end': '2017-01-31',
+            'type_id': self.date_range_type_month.id,
+            'company_id': self.company.id,
+        })
+        self.date_range_january_no_comp_2017 = self.DateRangeObj.create({
+            'name': "January 2017",
+            'date_start': '2017-01-01',
+            'date_end': '2017-01-31',
+            'type_id': self.date_range_type_month.id,
+            'company_id': False,
+        })
+
+    def test_01_delete_type_fiscal_month(self):
+        with self.assertRaises(UserError):
+            self.date_range_type_month.unlink()
+
+    def test_02_search_date_range(self):
+        january_2017_1st = Date.from_string('2017-01-01')
+        date_ranges = self.company.find_daterange_fm(january_2017_1st)
+
+        self.assertEquals(len(date_ranges), 1)
+        self.assertEquals(date_ranges[0], self.date_range_january_2017)

account_fiscal_month/views/date_range_type.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2017 ACSONE SA/NV
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+
+<odoo>
+
+    <record model="ir.ui.view" id="date_range_type_form_view">
+        <field name="name">date.range.type.form (in account_fiscal_month)</field>
+        <field name="model">date.range.type</field>
+        <field name="inherit_id" ref="date_range.view_date_range_type_form_view"/>
+        <field name="arch" type="xml">
+
+            <field name="allow_overlap" position="after">
+                <field name="fiscal_month"/>
+            </field>
+
+        </field>
+    </record>
+
+    <record model="ir.ui.view" id="date_range_type_tree_view">
+        <field name="name">date.range.type.tree (in account_fiscal_month)</field>
+        <field name="model">date.range.type</field>
+        <field name="inherit_id" ref="date_range.view_date_range_type_tree"/>
+        <field name="arch" type="xml">
+
+            <field name="allow_overlap" position="after">
+                <field name="fiscal_month"/>
+            </field>
+
+        </field>
+    </record>
+
+</odoo>